~bzr-pqm/bzr/bzr.dev

5582.5.1 by John Arbash Meinel
Fix bug 701212. Don't set the tags for a master branch during update.
1
# Copyright (C) 2005-2011 Canonical Ltd
1553.5.70 by Martin Pool
doc
2
#
1 by mbp at sourcefrog
import from baz patch-364
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.
1553.5.70 by Martin Pool
doc
7
#
1 by mbp at sourcefrog
import from baz patch-364
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.
1553.5.70 by Martin Pool
doc
12
#
1 by mbp at sourcefrog
import from baz patch-364
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1 by mbp at sourcefrog
import from baz patch-364
16
17
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
18
from cStringIO import StringIO
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
19
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
22
import itertools
1551.8.4 by Aaron Bentley
Tweak import style
23
from bzrlib import (
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
24
        bzrdir,
25
        cache_utf8,
5915.1.1 by Andrew Bennetts
Removed bzrlib.branch._run_with_write_locked_target. Use bzrlib.cleanup instead.
26
        cleanup,
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
27
        config as _mod_config,
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
28
        debug,
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
29
        errors,
5535.3.45 by Andrew Bennetts
Merge fetch-all-tags-309682.
30
        fetch,
5535.3.28 by Andrew Bennetts
Implement fetching tags during branch pull. Needs more tests.
31
        graph as _mod_graph,
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
32
        lockdir,
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
33
        lockable_files,
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
34
        remote,
3287.6.8 by Robert Collins
Reduce code duplication as per review.
35
        repository,
1996.3.12 by John Arbash Meinel
Change how 'revision' is imported to avoid problems later
36
        revision as _mod_revision,
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
37
        rio,
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
38
        tag as _mod_tag,
1911.2.9 by John Arbash Meinel
Fix accidental import removal
39
        transport,
4509.3.6 by Martin Pool
Show progress bar while unstacking
40
        ui,
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
41
        urlutils,
1551.8.4 by Aaron Bentley
Tweak import style
42
        )
6143.1.4 by Jonathan Riddell
update tests
43
from bzrlib.i18n import gettext, ngettext
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
44
""")
45
5697.2.1 by Jelmer Vernooij
Move weave branch to bzrlib.branch_weave.
46
from bzrlib import (
47
    controldir,
48
    )
49
from bzrlib.decorators import (
50
    needs_read_lock,
51
    needs_write_lock,
52
    only_raises,
53
    )
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
54
from bzrlib.hooks import Hooks
3978.3.2 by Jelmer Vernooij
Move most of push to IterGenericBranchBzrDir.
55
from bzrlib.inter import InterObject
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
56
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
57
from bzrlib import registry
3407.2.11 by Martin Pool
Deprecate Branch.abspath
58
from bzrlib.symbol_versioning import (
59
    deprecated_in,
60
    deprecated_method,
61
    )
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
62
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
1104 by Martin Pool
- Add a simple UIFactory
63
1094 by Martin Pool
- merge aaron's merge improvements 999..1008
64
5363.2.10 by Jelmer Vernooij
base ControlDir on ControlComponent.
65
class Branch(controldir.ControlComponent):
1 by mbp at sourcefrog
import from baz patch-364
66
    """Branch holding a history of revisions.
67
5158.6.2 by Martin Pool
Branch provides user_url etc
68
    :ivar base:
69
        Base directory/url of the branch; using control_url and
70
        control_transport is more standardized.
5609.25.6 by Andrew Bennetts
Docstring tweaks.
71
    :ivar hooks: An instance of BranchHooks.
72
    :ivar _master_branch_cache: cached result of get_master_branch, see
73
        _clear_cached_state.
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
74
    """
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
75
    # this is really an instance variable - FIXME move it there
76
    # - RBC 20060112
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
77
    base = None
78
5158.6.2 by Martin Pool
Branch provides user_url etc
79
    @property
80
    def control_transport(self):
81
        return self._transport
82
83
    @property
84
    def user_transport(self):
85
        return self.bzrdir.user_transport
86
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
87
    def __init__(self, *ignored, **ignored_too):
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
88
        self.tags = self._format.make_tags(self)
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
89
        self._revision_history_cache = None
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
90
        self._revision_id_to_revno_cache = None
3949.2.6 by Ian Clatworthy
review feedback from jam
91
        self._partial_revision_id_to_revno_cache = {}
4419.2.1 by Andrew Bennetts
Move _extend_partial_history into Branch base class, and use it in get_rev_id rather than self.revision_history().
92
        self._partial_revision_history_cache = []
5535.2.1 by Andrew Bennetts
Cache a branch's tags during a read-lock.
93
        self._tags_bytes = None
3441.5.27 by Andrew Bennetts
Tweaks suggested by John's review: rename _check_if_descendant_or_diverged, move caching last_revision_info into base Branch, better use of lock decorators.
94
        self._last_revision_info_cache = None
5609.25.3 by Andrew Bennetts
Alternative fix: cache the result of get_master_branch for the lifetime of the branch lock.
95
        self._master_branch_cache = None
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
96
        self._merge_sorted_revisions_cache = None
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
97
        self._open_hook()
3681.1.1 by Robert Collins
Create a new hook Branch.open. (Robert Collins)
98
        hooks = Branch.hooks['open']
99
        for hook in hooks:
100
            hook(self)
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
101
102
    def _open_hook(self):
103
        """Called by init to allow simpler extension of the base class."""
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
104
4379.2.2 by John Arbash Meinel
Change the Repository.add_fallback_repository() contract slightly.
105
    def _activate_fallback_location(self, url):
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
106
        """Activate the branch/repository from url as a fallback repository."""
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
107
        for existing_fallback_repo in self.repository._fallback_repositories:
108
            if existing_fallback_repo.user_url == url:
109
                # This fallback is already configured.  This probably only
110
                # happens because BzrDir.sprout is a horrible mess.  To avoid
111
                # confusing _unstack we don't add this a second time.
5536.1.9 by Andrew Bennetts
Do as the XXX and John's review suggest: log a warning about duplicate fallback activation.
112
                mutter('duplicate activation of fallback %r on %r', url, self)
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
113
                return
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
114
        repo = self._get_fallback_repository(url)
4462.3.2 by Robert Collins
Do not stack on the same branch/repository anymore. This was never supported and would generally result in infinite recursion. Fixes bug 376243.
115
        if repo.has_same_location(self.repository):
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
116
            raise errors.UnstackableLocationError(self.user_url, url)
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
117
        self.repository.add_fallback_repository(repo)
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
118
1687.1.8 by Robert Collins
Teach Branch about break_lock.
119
    def break_lock(self):
120
        """Break a lock if one is present from another instance.
121
122
        Uses the ui factory to ask for confirmation if the lock may be from
123
        an active process.
124
125
        This will probe the repository for its lock as well.
126
        """
127
        self.control_files.break_lock()
128
        self.repository.break_lock()
1687.1.10 by Robert Collins
Branch.break_lock should handle bound branches too
129
        master = self.get_master_branch()
130
        if master is not None:
131
            master.break_lock()
1687.1.8 by Robert Collins
Teach Branch about break_lock.
132
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
133
    def _check_stackable_repo(self):
134
        if not self.repository._format.supports_external_lookups:
135
            raise errors.UnstackableRepositoryFormat(self.repository._format,
136
                self.repository.base)
137
4419.2.1 by Andrew Bennetts
Move _extend_partial_history into Branch base class, and use it in get_rev_id rather than self.revision_history().
138
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
139
        """Extend the partial history to include a given index
140
141
        If a stop_index is supplied, stop when that index has been reached.
142
        If a stop_revision is supplied, stop when that revision is
143
        encountered.  Otherwise, stop when the beginning of history is
144
        reached.
145
146
        :param stop_index: The index which should be present.  When it is
147
            present, history extension will stop.
4419.2.3 by Andrew Bennetts
Refactor _extend_partial_history into a standalone function that can be used without a branch.
148
        :param stop_revision: The revision id which should be present.  When
4419.2.1 by Andrew Bennetts
Move _extend_partial_history into Branch base class, and use it in get_rev_id rather than self.revision_history().
149
            it is encountered, history extension will stop.
150
        """
151
        if len(self._partial_revision_history_cache) == 0:
4419.2.3 by Andrew Bennetts
Refactor _extend_partial_history into a standalone function that can be used without a branch.
152
            self._partial_revision_history_cache = [self.last_revision()]
153
        repository._iter_for_revno(
154
            self.repository, self._partial_revision_history_cache,
155
            stop_index=stop_index, stop_revision=stop_revision)
156
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
157
            self._partial_revision_history_cache.pop()
4419.2.1 by Andrew Bennetts
Move _extend_partial_history into Branch base class, and use it in get_rev_id rather than self.revision_history().
158
4332.3.5 by Robert Collins
Add Branch._get_check_refs.
159
    def _get_check_refs(self):
160
        """Get the references needed for check().
161
162
        See bzrlib.check.
163
        """
164
        revid = self.last_revision()
165
        return [('revision-existence', revid), ('lefthand-distance', revid)]
166
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
167
    @staticmethod
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
168
    def open(base, _unsupported=False, possible_transports=None):
1815.1.1 by Jelmer Vernooij
Fix copy-pasted comment.
169
        """Open the branch rooted at base.
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
170
1815.1.1 by Jelmer Vernooij
Fix copy-pasted comment.
171
        For instance, if the branch is at URL/.bzr/branch,
172
        Branch.open(URL) -> a Branch instance.
1534.4.7 by Robert Collins
Move downlevel check up to the Branch.open logic, removing it from the Branch constructor and deprecating relax_version_check to the same.
173
        """
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
174
        control = bzrdir.BzrDir.open(base, _unsupported,
175
                                     possible_transports=possible_transports)
5051.3.4 by Jelmer Vernooij
Support name to BzrDir.open_branch.
176
        return control.open_branch(unsupported=_unsupported)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
177
178
    @staticmethod
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
179
    def open_from_transport(transport, name=None, _unsupported=False):
2485.8.35 by Vincent Ladeuil
Fix pull multiple connections.
180
        """Open the branch rooted at transport"""
181
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
182
        return control.open_branch(name=name, unsupported=_unsupported)
2485.8.35 by Vincent Ladeuil
Fix pull multiple connections.
183
184
    @staticmethod
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
185
    def open_containing(url, possible_transports=None):
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
186
        """Open an existing branch which contains url.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
187
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
188
        This probes for a branch at url, and searches upwards from there.
1185.17.2 by Martin Pool
[pick] avoid problems in fetching when .bzr is not listable
189
190
        Basically we keep looking up until we find the control directory or
191
        run into the root.  If there isn't one, raises NotBranchError.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
192
        If there is one and it is either an unrecognised format or an unsupported
1534.4.22 by Robert Collins
update TODOs and move abstract methods that were misplaced on BzrBranchFormat5 to Branch.
193
        format, UnknownFormatError or UnsupportedFormatError are raised.
1442.1.64 by Robert Collins
Branch.open_containing now returns a tuple (Branch, relative-path).
194
        If there is one, it is returned, along with the unused portion of url.
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
195
        """
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
196
        control, relpath = bzrdir.BzrDir.open_containing(url,
197
                                                         possible_transports)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
198
        return control.open_branch(), relpath
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
199
4032.3.5 by Robert Collins
Move BzrBranch._push_should_merge_tags to Branch.
200
    def _push_should_merge_tags(self):
201
        """Should _basic_push merge this branch's tags into the target?
202
203
        The default implementation returns False if this branch has no tags,
204
        and True the rest of the time.  Subclasses may override this.
205
        """
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
206
        return self.supports_tags() and self.tags.get_tag_dict()
4032.3.5 by Robert Collins
Move BzrBranch._push_should_merge_tags to Branch.
207
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
208
    def get_config(self):
5284.3.1 by Robert Collins
Document bzrlib.branch.Branch.get_config.
209
        """Get a bzrlib.config.BranchConfig for this Branch.
210
211
        This can then be used to get and set configuration options for the
212
        branch.
213
214
        :return: A bzrlib.config.BranchConfig.
215
        """
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
216
        return _mod_config.BranchConfig(self)
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
217
6155.2.1 by Vincent Ladeuil
Migrate dpush_strict, push_strict and send_strict options to the stack based config design, introducing get_config_stack for branches.
218
    def get_config_stack(self):
219
        """Get a bzrlib.config.BranchStack for this Branch.
220
221
        This can then be used to get and set configuration options for the
222
        branch.
223
224
        :return: A bzrlib.config.BranchStack.
225
        """
226
        return _mod_config.BranchStack(self)
227
4226.1.5 by Robert Collins
Reinstate the use of the Branch.get_config_file verb.
228
    def _get_config(self):
229
        """Get the concrete config for just the config in this branch.
230
231
        This is not intended for client use; see Branch.get_config for the
232
        public API.
233
234
        Added in 1.14.
235
236
        :return: An object supporting get_option and set_option.
237
        """
238
        raise NotImplementedError(self._get_config)
239
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
240
    def _get_fallback_repository(self, url):
241
        """Get the repository we fallback to at url."""
242
        url = urlutils.join(self.base, url)
5051.3.14 by Jelmer Vernooij
Remove use of BzrDir.open_branch() without arguments.
243
        a_branch = Branch.open(url,
4226.1.4 by Robert Collins
Simplify code in RemoteBranch to use helpers from Branch.
244
            possible_transports=[self.bzrdir.root_transport])
5051.3.14 by Jelmer Vernooij
Remove use of BzrDir.open_branch() without arguments.
245
        return a_branch.repository
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
246
5535.2.1 by Andrew Bennetts
Cache a branch's tags during a read-lock.
247
    @needs_read_lock
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
248
    def _get_tags_bytes(self):
249
        """Get the bytes of a serialised tags dict.
250
251
        Note that not all branches support tags, nor do all use the same tags
252
        logic: this method is specific to BasicTags. Other tag implementations
253
        may use the same method name and behave differently, safely, because
254
        of the double-dispatch via
255
        format.make_tags->tags_instance->get_tags_dict.
256
257
        :return: The bytes of the tags file.
258
        :seealso: Branch._set_tags_bytes.
259
        """
5535.2.1 by Andrew Bennetts
Cache a branch's tags during a read-lock.
260
        if self._tags_bytes is None:
261
            self._tags_bytes = self._transport.get_bytes('tags')
262
        return self._tags_bytes
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
263
3815.3.4 by Marius Kruger
When doing a `commit --local`, don't try to connect to the master branch.
264
    def _get_nick(self, local=False, possible_transports=None):
3565.6.7 by Marius Kruger
* checkouts now use master nick when no explicit nick is set.
265
        config = self.get_config()
3815.3.4 by Marius Kruger
When doing a `commit --local`, don't try to connect to the master branch.
266
        # explicit overrides master, but don't look for master if local is True
267
        if not local and not config.has_explicit_nickname():
3565.6.10 by Marius Kruger
Silently fall back to local implicit nick if the master is unavailable
268
            try:
269
                master = self.get_master_branch(possible_transports)
5050.7.4 by Parth Malwankar
fixed recursion detection to handle shared repos
270
                if master and self.user_url == master.user_url:
5050.7.5 by Parth Malwankar
better error message for RecursiveBind
271
                    raise errors.RecursiveBind(self.user_url)
3565.6.10 by Marius Kruger
Silently fall back to local implicit nick if the master is unavailable
272
                if master is not None:
273
                    # return the master branch value
3815.3.3 by Marius Kruger
apply Martin's fix for #293440
274
                    return master.nick
5050.7.2 by Parth Malwankar
recursive binding now shows a clear error
275
            except errors.RecursiveBind, e:
276
                raise e
3565.6.10 by Marius Kruger
Silently fall back to local implicit nick if the master is unavailable
277
            except errors.BzrError, e:
278
                # Silently fall back to local implicit nick if the master is
279
                # unavailable
280
                mutter("Could not connect to bound branch, "
281
                    "falling back to local nick.\n " + str(e))
3565.6.7 by Marius Kruger
* checkouts now use master nick when no explicit nick is set.
282
        return config.get_nickname()
1185.35.11 by Aaron Bentley
Added support for branch nicks
283
284
    def _set_nick(self, nick):
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
285
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
1185.35.11 by Aaron Bentley
Added support for branch nicks
286
287
    nick = property(_get_nick, _set_nick)
1694.2.6 by Martin Pool
[merge] bzr.dev
288
289
    def is_locked(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
290
        raise NotImplementedError(self.is_locked)
1694.2.6 by Martin Pool
[merge] bzr.dev
291
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
292
    def _lefthand_history(self, revision_id, last_rev=None,
293
                          other_branch=None):
294
        if 'evil' in debug.debug_flags:
295
            mutter_callsite(4, "_lefthand_history scales with history.")
296
        # stop_revision must be a descendant of last_revision
297
        graph = self.repository.get_graph()
298
        if last_rev is not None:
299
            if not graph.is_ancestor(last_rev, revision_id):
300
                # our previous tip is not merged into stop_revision
301
                raise errors.DivergedBranches(self, other_branch)
302
        # make a new revision history from the graph
303
        parents_map = graph.get_parent_map([revision_id])
304
        if revision_id not in parents_map:
305
            raise errors.NoSuchRevision(self, revision_id)
306
        current_rev_id = revision_id
307
        new_history = []
308
        check_not_reserved_id = _mod_revision.check_not_reserved_id
309
        # Do not include ghosts or graph origin in revision_history
310
        while (current_rev_id in parents_map and
311
               len(parents_map[current_rev_id]) > 0):
312
            check_not_reserved_id(current_rev_id)
313
            new_history.append(current_rev_id)
314
            current_rev_id = parents_map[current_rev_id][0]
315
            parents_map = graph.get_parent_map([current_rev_id])
316
        new_history.reverse()
317
        return new_history
318
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
319
    def lock_write(self, token=None):
320
        """Lock the branch for write operations.
321
322
        :param token: A token to permit reacquiring a previously held and
323
            preserved lock.
324
        :return: A BranchWriteLockResult.
325
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
326
        raise NotImplementedError(self.lock_write)
1694.2.6 by Martin Pool
[merge] bzr.dev
327
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
328
    def lock_read(self):
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
329
        """Lock the branch for read operations.
330
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
331
        :return: A bzrlib.lock.LogicalLockResult.
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
332
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
333
        raise NotImplementedError(self.lock_read)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
334
335
    def unlock(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
336
        raise NotImplementedError(self.unlock)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
337
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
338
    def peek_lock_mode(self):
339
        """Return lock mode for the Branch: 'r', 'w' or None"""
1185.70.6 by Martin Pool
review fixups from John
340
        raise NotImplementedError(self.peek_lock_mode)
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
341
1694.2.6 by Martin Pool
[merge] bzr.dev
342
    def get_physical_lock_status(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
343
        raise NotImplementedError(self.get_physical_lock_status)
1694.2.6 by Martin Pool
[merge] bzr.dev
344
2418.5.12 by John Arbash Meinel
Move functions from BzrBranch to base Branch object.
345
    @needs_read_lock
3949.2.6 by Ian Clatworthy
review feedback from jam
346
    def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
347
        """Return the revision_id for a dotted revno.
348
349
        :param revno: a tuple like (1,) or (1,1,2)
3949.2.4 by Ian Clatworthy
add top level revno cache
350
        :param _cache_reverse: a private parameter enabling storage
351
           of the reverse mapping in a top level cache. (This should
352
           only be done in selective circumstances as we want to
353
           avoid having the mapping cached multiple times.)
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
354
        :return: the revision_id
355
        :raises errors.NoSuchRevision: if the revno doesn't exist
356
        """
3949.2.6 by Ian Clatworthy
review feedback from jam
357
        rev_id = self._do_dotted_revno_to_revision_id(revno)
358
        if _cache_reverse:
359
            self._partial_revision_id_to_revno_cache[rev_id] = revno
3949.2.4 by Ian Clatworthy
add top level revno cache
360
        return rev_id
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
361
3949.2.6 by Ian Clatworthy
review feedback from jam
362
    def _do_dotted_revno_to_revision_id(self, revno):
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
363
        """Worker function for dotted_revno_to_revision_id.
364
365
        Subclasses should override this if they wish to
366
        provide a more efficient implementation.
367
        """
368
        if len(revno) == 1:
369
            return self.get_rev_id(revno[0])
370
        revision_id_to_revno = self.get_revision_id_to_revno_map()
3949.2.6 by Ian Clatworthy
review feedback from jam
371
        revision_ids = [revision_id for revision_id, this_revno
372
                        in revision_id_to_revno.iteritems()
373
                        if revno == this_revno]
374
        if len(revision_ids) == 1:
375
            return revision_ids[0]
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
376
        else:
377
            revno_str = '.'.join(map(str, revno))
378
            raise errors.NoSuchRevision(self, revno_str)
379
380
    @needs_read_lock
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
381
    def revision_id_to_dotted_revno(self, revision_id):
382
        """Given a revision id, return its dotted revno.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
383
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
384
        :return: a tuple like (1,) or (400,1,3).
385
        """
3949.2.6 by Ian Clatworthy
review feedback from jam
386
        return self._do_revision_id_to_dotted_revno(revision_id)
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
387
3949.2.6 by Ian Clatworthy
review feedback from jam
388
    def _do_revision_id_to_dotted_revno(self, revision_id):
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
389
        """Worker function for revision_id_to_revno."""
3949.2.4 by Ian Clatworthy
add top level revno cache
390
        # Try the caches if they are loaded
3949.2.6 by Ian Clatworthy
review feedback from jam
391
        result = self._partial_revision_id_to_revno_cache.get(revision_id)
392
        if result is not None:
393
            return result
394
        if self._revision_id_to_revno_cache:
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
395
            result = self._revision_id_to_revno_cache.get(revision_id)
3949.2.6 by Ian Clatworthy
review feedback from jam
396
            if result is None:
397
                raise errors.NoSuchRevision(self, revision_id)
398
        # Try the mainline as it's optimised
399
        try:
400
            revno = self.revision_id_to_revno(revision_id)
401
            return (revno,)
402
        except errors.NoSuchRevision:
403
            # We need to load and use the full revno map after all
404
            result = self.get_revision_id_to_revno_map().get(revision_id)
405
            if result is None:
406
                raise errors.NoSuchRevision(self, revision_id)
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
407
        return result
408
3949.2.7 by Ian Clatworthy
fix accidental needs_read_lock removal
409
    @needs_read_lock
2418.5.12 by John Arbash Meinel
Move functions from BzrBranch to base Branch object.
410
    def get_revision_id_to_revno_map(self):
411
        """Return the revision_id => dotted revno map.
412
413
        This will be regenerated on demand, but will be cached.
414
415
        :return: A dictionary mapping revision_id => dotted revno.
416
            This dictionary should not be modified by the caller.
417
        """
418
        if self._revision_id_to_revno_cache is not None:
419
            mapping = self._revision_id_to_revno_cache
420
        else:
421
            mapping = self._gen_revno_map()
422
            self._cache_revision_id_to_revno(mapping)
423
        # TODO: jam 20070417 Since this is being cached, should we be returning
424
        #       a copy?
425
        # I would rather not, and instead just declare that users should not
426
        # modify the return value.
427
        return mapping
428
429
    def _gen_revno_map(self):
430
        """Create a new mapping from revision ids to dotted revnos.
431
432
        Dotted revnos are generated based on the current tip in the revision
433
        history.
434
        This is the worker function for get_revision_id_to_revno_map, which
435
        just caches the return value.
436
437
        :return: A dictionary mapping revision_id => dotted revno.
438
        """
3949.3.1 by Ian Clatworthy
introduce Branch.merge_sorted_revisions API
439
        revision_id_to_revno = dict((rev_id, revno)
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
440
            for rev_id, depth, revno, end_of_merge
441
             in self.iter_merge_sorted_revisions())
3949.3.1 by Ian Clatworthy
introduce Branch.merge_sorted_revisions API
442
        return revision_id_to_revno
443
444
    @needs_read_lock
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
445
    def iter_merge_sorted_revisions(self, start_revision_id=None,
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
446
            stop_revision_id=None, stop_rule='exclude', direction='reverse'):
3949.3.2 by Ian Clatworthy
feedback from jam
447
        """Walk the revisions for a branch in merge sorted order.
3949.3.1 by Ian Clatworthy
introduce Branch.merge_sorted_revisions API
448
3949.3.8 by Ian Clatworthy
feedback from poolie
449
        Merge sorted order is the output from a merge-aware,
450
        topological sort, i.e. all parents come before their
451
        children going forward; the opposite for reverse.
452
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
453
        :param start_revision_id: the revision_id to begin walking from.
454
            If None, the branch tip is used.
455
        :param stop_revision_id: the revision_id to terminate the walk
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
456
            after. If None, the rest of history is included.
457
        :param stop_rule: if stop_revision_id is not None, the precise rule
458
            to use for termination:
5891.1.3 by Andrew Bennetts
Move docstring formatting fixes.
459
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
460
            * 'exclude' - leave the stop revision out of the result (default)
461
            * 'include' - the stop revision is the last item in the result
462
            * 'with-merges' - include the stop revision and all of its
463
              merged revisions in the result
5155.1.5 by Vincent Ladeuil
Fixed as per Andrew's review.
464
            * 'with-merges-without-common-ancestry' - filter out revisions 
465
              that are in both ancestries
3949.3.3 by Ian Clatworthy
simplify the meaning of forward to be appropriate to this layer
466
        :param direction: either 'reverse' or 'forward':
5891.1.3 by Andrew Bennetts
Move docstring formatting fixes.
467
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
468
            * reverse means return the start_revision_id first, i.e.
469
              start at the most recent revision and go backwards in history
3949.3.3 by Ian Clatworthy
simplify the meaning of forward to be appropriate to this layer
470
            * forward returns tuples in the opposite order to reverse.
471
              Note in particular that forward does *not* do any intelligent
472
              ordering w.r.t. depth as some clients of this API may like.
3949.3.8 by Ian Clatworthy
feedback from poolie
473
              (If required, that ought to be done at higher layers.)
474
475
        :return: an iterator over (revision_id, depth, revno, end_of_merge)
476
            tuples where:
477
478
            * revision_id: the unique id of the revision
479
            * depth: How many levels of merging deep this node has been
480
              found.
481
            * revno_sequence: This field provides a sequence of
482
              revision numbers for all revisions. The format is:
483
              (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
484
              branch that the revno is on. From left to right the REVNO numbers
485
              are the sequence numbers within that branch of the revision.
486
            * end_of_merge: When True the next node (earlier in history) is
487
              part of a different merge.
3949.3.1 by Ian Clatworthy
introduce Branch.merge_sorted_revisions API
488
        """
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
489
        # Note: depth and revno values are in the context of the branch so
490
        # we need the full graph to get stable numbers, regardless of the
491
        # start_revision_id.
492
        if self._merge_sorted_revisions_cache is None:
493
            last_revision = self.last_revision()
4913.4.2 by Jelmer Vernooij
Add Repository.get_known_graph_ancestry.
494
            known_graph = self.repository.get_known_graph_ancestry(
495
                [last_revision])
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
496
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
4913.4.2 by Jelmer Vernooij
Add Repository.get_known_graph_ancestry.
497
                last_revision)
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
498
        filtered = self._filter_merge_sorted_revisions(
499
            self._merge_sorted_revisions_cache, start_revision_id,
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
500
            stop_revision_id, stop_rule)
5097.1.5 by Vincent Ladeuil
First attempt at fixing the bug, fortunately the bug report exhibits an
501
        # Make sure we don't return revisions that are not part of the
502
        # start_revision_id ancestry.
5097.1.12 by Vincent Ladeuil
Implement the --exclude-common-ancestry log option.
503
        filtered = self._filter_start_non_ancestors(filtered)
3949.3.2 by Ian Clatworthy
feedback from jam
504
        if direction == 'reverse':
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
505
            return filtered
3949.3.2 by Ian Clatworthy
feedback from jam
506
        if direction == 'forward':
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
507
            return reversed(list(filtered))
3949.3.2 by Ian Clatworthy
feedback from jam
508
        else:
509
            raise ValueError('invalid direction %r' % direction)
2418.5.12 by John Arbash Meinel
Move functions from BzrBranch to base Branch object.
510
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
511
    def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
512
        start_revision_id, stop_revision_id, stop_rule):
3949.3.7 by Ian Clatworthy
drop seqnum from in-memory cache
513
        """Iterate over an inclusive range of sorted revisions."""
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
514
        rev_iter = iter(merge_sorted_revisions)
515
        if start_revision_id is not None:
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
516
            for node in rev_iter:
5988.1.2 by Jelmer Vernooij
Fix log.
517
                rev_id = node.key
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
518
                if rev_id != start_revision_id:
519
                    continue
520
                else:
3936.3.30 by Ian Clatworthy
use iter_merge_sorted_revisions() with stop_range feature
521
                    # The decision to include the start or not
522
                    # depends on the stop_rule if a stop is provided
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
523
                    # so pop this node back into the iterator
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
524
                    rev_iter = itertools.chain(iter([node]), rev_iter)
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
525
                    break
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
526
        if stop_revision_id is None:
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
527
            # Yield everything
528
            for node in rev_iter:
5988.1.2 by Jelmer Vernooij
Fix log.
529
                rev_id = node.key
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
530
                yield (rev_id, node.merge_depth, node.revno,
531
                       node.end_of_merge)
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
532
        elif stop_rule == 'exclude':
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
533
            for node in rev_iter:
5988.1.2 by Jelmer Vernooij
Fix log.
534
                rev_id = node.key
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
535
                if rev_id == stop_revision_id:
536
                    return
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
537
                yield (rev_id, node.merge_depth, node.revno,
538
                       node.end_of_merge)
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
539
        elif stop_rule == 'include':
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
540
            for node in rev_iter:
5988.1.2 by Jelmer Vernooij
Fix log.
541
                rev_id = node.key
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
542
                yield (rev_id, node.merge_depth, node.revno,
543
                       node.end_of_merge)
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
544
                if rev_id == stop_revision_id:
545
                    return
5097.1.11 by Vincent Ladeuil
Fix bug #320119 in a crude way.
546
        elif stop_rule == 'with-merges-without-common-ancestry':
547
            # We want to exclude all revisions that are already part of the
548
            # stop_revision_id ancestry.
549
            graph = self.repository.get_graph()
5155.1.3 by Vincent Ladeuil
Fix the performance by finding the relevant subgraph once.
550
            ancestors = graph.find_unique_ancestors(start_revision_id,
551
                                                    [stop_revision_id])
5097.1.11 by Vincent Ladeuil
Fix bug #320119 in a crude way.
552
            for node in rev_iter:
5988.1.2 by Jelmer Vernooij
Fix log.
553
                rev_id = node.key
5155.1.3 by Vincent Ladeuil
Fix the performance by finding the relevant subgraph once.
554
                if rev_id not in ancestors:
5097.1.11 by Vincent Ladeuil
Fix bug #320119 in a crude way.
555
                    continue
556
                yield (rev_id, node.merge_depth, node.revno,
557
                       node.end_of_merge)
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
558
        elif stop_rule == 'with-merges':
3960.3.4 by Ian Clatworthy
implement with-merges by checking for left-hand parent, not depth
559
            stop_rev = self.repository.get_revision(stop_revision_id)
560
            if stop_rev.parent_ids:
4511.3.15 by Marius Kruger
mainline_stop_rev -> left_parent
561
                left_parent = stop_rev.parent_ids[0]
3960.3.4 by Ian Clatworthy
implement with-merges by checking for left-hand parent, not depth
562
            else:
4511.3.15 by Marius Kruger
mainline_stop_rev -> left_parent
563
                left_parent = _mod_revision.NULL_REVISION
564
            # left_parent is the actual revision we want to stop logging at,
565
            # since we want to show the merged revisions after the stop_rev too
4511.3.10 by Marius Kruger
log -n0 should log up until the stop_revision with its meges and no further.
566
            reached_stop_revision_id = False
4511.3.12 by Marius Kruger
ununinvert logic and improve some variable names.
567
            revision_id_whitelist = []
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
568
            for node in rev_iter:
5988.1.2 by Jelmer Vernooij
Fix log.
569
                rev_id = node.key
4511.3.15 by Marius Kruger
mainline_stop_rev -> left_parent
570
                if rev_id == left_parent:
571
                    # reached the left parent after the stop_revision
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
572
                    return
4511.3.12 by Marius Kruger
ununinvert logic and improve some variable names.
573
                if (not reached_stop_revision_id or
574
                        rev_id in revision_id_whitelist):
4511.3.10 by Marius Kruger
log -n0 should log up until the stop_revision with its meges and no further.
575
                    yield (rev_id, node.merge_depth, node.revno,
4593.5.34 by John Arbash Meinel
Change the KnownGraph.merge_sort api.
576
                       node.end_of_merge)
4511.3.10 by Marius Kruger
log -n0 should log up until the stop_revision with its meges and no further.
577
                    if reached_stop_revision_id or rev_id == stop_revision_id:
578
                        # only do the merged revs of rev_id from now on
579
                        rev = self.repository.get_revision(rev_id)
580
                        if rev.parent_ids:
581
                            reached_stop_revision_id = True
4511.3.12 by Marius Kruger
ununinvert logic and improve some variable names.
582
                            revision_id_whitelist.extend(rev.parent_ids)
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
583
        else:
584
            raise ValueError('invalid stop_rule %r' % stop_rule)
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
585
5097.1.12 by Vincent Ladeuil
Implement the --exclude-common-ancestry log option.
586
    def _filter_start_non_ancestors(self, rev_iter):
5097.1.5 by Vincent Ladeuil
First attempt at fixing the bug, fortunately the bug report exhibits an
587
        # If we started from a dotted revno, we want to consider it as a tip
588
        # and don't want to yield revisions that are not part of its
589
        # ancestry. Given the order guaranteed by the merge sort, we will see
590
        # uninteresting descendants of the first parent of our tip before the
591
        # tip itself.
592
        first = rev_iter.next()
593
        (rev_id, merge_depth, revno, end_of_merge) = first
594
        yield first
595
        if not merge_depth:
596
            # We start at a mainline revision so by definition, all others
597
            # revisions in rev_iter are ancestors
598
            for node in rev_iter:
599
                yield node
600
5097.2.2 by Vincent Ladeuil
Fix performance.
601
        clean = False
5097.2.1 by Vincent Ladeuil
Fix bug #474807 but performance suffers.
602
        whitelist = set()
5097.2.3 by Vincent Ladeuil
Better performance than before the fix.
603
        pmap = self.repository.get_parent_map([rev_id])
604
        parents = pmap.get(rev_id, [])
605
        if parents:
606
            whitelist.update(parents)
5097.1.5 by Vincent Ladeuil
First attempt at fixing the bug, fortunately the bug report exhibits an
607
        else:
5097.1.8 by Vincent Ladeuil
Remove the comment about the missing test (it's not worth it at the
608
            # If there is no parents, there is nothing of interest left
609
610
            # FIXME: It's hard to test this scenario here as this code is never
611
            # called in that case. -- vila 20100322
612
            return
613
5097.1.5 by Vincent Ladeuil
First attempt at fixing the bug, fortunately the bug report exhibits an
614
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
5097.2.2 by Vincent Ladeuil
Fix performance.
615
            if not clean:
616
                if rev_id in whitelist:
5097.2.3 by Vincent Ladeuil
Better performance than before the fix.
617
                    pmap = self.repository.get_parent_map([rev_id])
618
                    parents = pmap.get(rev_id, [])
5097.2.2 by Vincent Ladeuil
Fix performance.
619
                    whitelist.remove(rev_id)
5097.2.3 by Vincent Ladeuil
Better performance than before the fix.
620
                    whitelist.update(parents)
5097.2.2 by Vincent Ladeuil
Fix performance.
621
                    if merge_depth == 0:
622
                        # We've reached the mainline, there is nothing left to
623
                        # filter
624
                        clean = True
625
                else:
626
                    # A revision that is not part of the ancestry of our
627
                    # starting revision.
628
                    continue
5097.1.5 by Vincent Ladeuil
First attempt at fixing the bug, fortunately the bug report exhibits an
629
            yield (rev_id, merge_depth, revno, end_of_merge)
630
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
631
    def leave_lock_in_place(self):
632
        """Tell this branch object not to release the physical lock when this
633
        object is unlocked.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
634
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
635
        If lock_write doesn't return a token, then this method is not supported.
636
        """
637
        self.control_files.leave_in_place()
638
639
    def dont_leave_lock_in_place(self):
640
        """Tell this branch object to release the physical lock when this
641
        object is unlocked, even if it didn't originally acquire it.
642
643
        If lock_write doesn't return a token, then this method is not supported.
644
        """
645
        self.control_files.dont_leave_in_place()
646
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
647
    def bind(self, other):
648
        """Bind the local branch the other branch.
649
650
        :param other: The branch to bind to
651
        :type other: Branch
652
        """
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
653
        raise errors.UpgradeRequired(self.user_url)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
654
6123.9.11 by Jelmer Vernooij
Make get_append_revisions_only public.
655
    def get_append_revisions_only(self):
656
        """Whether it is only possible to append revisions to the history.
657
        """
6123.9.14 by Jelmer Vernooij
Fix RemoteBranch.get_append_revisions_only().
658
        if not self._format.supports_set_append_revisions_only():
659
            return False
660
        return self.get_config(
661
            ).get_user_option_as_bool('append_revisions_only')
6123.9.11 by Jelmer Vernooij
Make get_append_revisions_only public.
662
4301.3.3 by Andrew Bennetts
Move check onto base Branch class, and add a supports_set_append_revisions_only method to BranchFormat, as suggested by Robert.
663
    def set_append_revisions_only(self, enabled):
664
        if not self._format.supports_set_append_revisions_only():
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
665
            raise errors.UpgradeRequired(self.user_url)
4301.3.3 by Andrew Bennetts
Move check onto base Branch class, and add a supports_set_append_revisions_only method to BranchFormat, as suggested by Robert.
666
        if enabled:
667
            value = 'True'
668
        else:
669
            value = 'False'
670
        self.get_config().set_user_option('append_revisions_only', value,
671
            warn_masked=True)
672
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
673
    def set_reference_info(self, file_id, tree_path, branch_location):
674
        """Set the branch location to use for a tree reference."""
675
        raise errors.UnsupportedOperation(self.set_reference_info, self)
676
677
    def get_reference_info(self, file_id):
678
        """Get the tree_path and branch_location for a tree reference."""
679
        raise errors.UnsupportedOperation(self.get_reference_info, self)
680
1534.1.31 by Robert Collins
Deprecated fetch.fetch and fetch.greedy_fetch for branch.fetch, and move the Repository.fetch internals to InterRepo and InterWeaveRepo.
681
    @needs_write_lock
5852.1.1 by Jelmer Vernooij
Add limit argument to Branch.fetch.
682
    def fetch(self, from_branch, last_revision=None, limit=None):
1534.1.31 by Robert Collins
Deprecated fetch.fetch and fetch.greedy_fetch for branch.fetch, and move the Repository.fetch internals to InterRepo and InterWeaveRepo.
683
        """Copy revisions from from_branch into this branch.
684
685
        :param from_branch: Where to copy from.
686
        :param last_revision: What revision to stop at (None for at the end
687
                              of the branch.
5852.1.1 by Jelmer Vernooij
Add limit argument to Branch.fetch.
688
        :param limit: Optional rough limit of revisions to fetch
4065.1.1 by Robert Collins
Change the return value of fetch() to None.
689
        :return: None
1534.1.31 by Robert Collins
Deprecated fetch.fetch and fetch.greedy_fetch for branch.fetch, and move the Repository.fetch internals to InterRepo and InterWeaveRepo.
690
        """
5852.1.4 by Jelmer Vernooij
Pass along limit=.
691
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
1534.1.31 by Robert Collins
Deprecated fetch.fetch and fetch.greedy_fetch for branch.fetch, and move the Repository.fetch internals to InterRepo and InterWeaveRepo.
692
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
693
    def get_bound_location(self):
1558.7.6 by Aaron Bentley
Fixed typo (Olaf Conradi)
694
        """Return the URL of the branch we are bound to.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
695
696
        Older format branches cannot bind, please be sure to use a metadir
697
        branch.
698
        """
699
        return None
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
700
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
701
    def get_old_bound_location(self):
702
        """Return the URL of the branch we used to be bound to
703
        """
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
704
        raise errors.UpgradeRequired(self.user_url)
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
705
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
706
    def get_commit_builder(self, parents, config=None, timestamp=None,
707
                           timezone=None, committer=None, revprops=None,
5777.6.1 by Jelmer Vernooij
Add --lossy option to 'bzr commit'.
708
                           revision_id=None, lossy=False):
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
709
        """Obtain a CommitBuilder for this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
710
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
711
        :param parents: Revision ids of the parents of the new revision.
712
        :param config: Optional configuration to use.
713
        :param timestamp: Optional timestamp recorded for commit.
714
        :param timezone: Optional timezone for timestamp.
715
        :param committer: Optional committer to set for commit.
716
        :param revprops: Optional dictionary of revision properties.
717
        :param revision_id: Optional revision id.
5777.6.1 by Jelmer Vernooij
Add --lossy option to 'bzr commit'.
718
        :param lossy: Whether to discard data that can not be natively
719
            represented, when pushing to a foreign VCS 
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
720
        """
721
722
        if config is None:
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
723
            config = self.get_config()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
724
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
725
        return self.repository.get_commit_builder(self, parents, config,
5777.6.1 by Jelmer Vernooij
Add --lossy option to 'bzr commit'.
726
            timestamp, timezone, committer, revprops, revision_id,
727
            lossy)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
728
2810.2.1 by Martin Pool
merge vincent and cleanup
729
    def get_master_branch(self, possible_transports=None):
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
730
        """Return the branch we are bound to.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
731
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
732
        :return: Either a Branch, or None
733
        """
734
        return None
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
735
1770.3.2 by Jelmer Vernooij
Move BzrBranch.get_revision_delta() to Branch.get_revision_delta() as it is generic.
736
    def get_revision_delta(self, revno):
737
        """Return the delta for one revision.
738
739
        The delta is relative to its mainline predecessor, or the
740
        empty tree for revision 1.
741
        """
742
        rh = self.revision_history()
743
        if not (1 <= revno <= len(rh)):
3236.1.2 by Michael Hudson
clean up branch.py imports
744
            raise errors.InvalidRevisionNumber(revno)
1770.3.2 by Jelmer Vernooij
Move BzrBranch.get_revision_delta() to Branch.get_revision_delta() as it is generic.
745
        return self.repository.get_revision_delta(rh[revno-1])
746
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
747
    def get_stacked_on_url(self):
3221.11.2 by Robert Collins
Create basic stackable branch facility.
748
        """Get the URL this branch is stacked against.
749
750
        :raises NotStacked: If the branch is not stacked.
751
        :raises UnstackableBranchFormat: If the branch does not support
752
            stacking.
753
        """
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
754
        raise NotImplementedError(self.get_stacked_on_url)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
755
1185.50.9 by John Arbash Meinel
[bug 3632] Matthieu Moy- bzr cat should default to last revision
756
    def print_file(self, file, revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
757
        """Print `file` to stdout."""
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
758
        raise NotImplementedError(self.print_file)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
759
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
760
    @deprecated_method(deprecated_in((2, 4, 0)))
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
761
    def set_revision_history(self, rev_history):
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
762
        """See Branch.set_revision_history."""
5718.8.18 by Jelmer Vernooij
Translate local set_rh calls to remote set_rh calls.
763
        self._set_revision_history(rev_history)
764
765
    @needs_write_lock
766
    def _set_revision_history(self, rev_history):
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
767
        if len(rev_history) == 0:
768
            revid = _mod_revision.NULL_REVISION
769
        else:
770
            revid = rev_history[-1]
5718.8.15 by Jelmer Vernooij
Check left hand history in Branch.set_revision_history.
771
        if rev_history != self._lefthand_history(revid):
772
            raise errors.NotLefthandHistory(rev_history)
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
773
        self.set_last_revision_info(len(rev_history), revid)
774
        self._cache_revision_history(rev_history)
5718.8.18 by Jelmer Vernooij
Translate local set_rh calls to remote set_rh calls.
775
        for hook in Branch.hooks['set_rh']:
776
            hook(self, rev_history)
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
777
778
    @needs_write_lock
779
    def set_last_revision_info(self, revno, revision_id):
5718.8.3 by Jelmer Vernooij
More branch restructuring.
780
        """Set the last revision of this branch.
781
782
        The caller is responsible for checking that the revno is correct
783
        for this revision id.
784
785
        It may be possible to set the branch last revision to an id not
786
        present in the repository.  However, branches can also be
787
        configured to check constraints on history, in which case this may not
788
        be permitted.
789
        """
5883.1.1 by Jelmer Vernooij
Fix NotImplementedError contents.
790
        raise NotImplementedError(self.set_last_revision_info)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
791
4288.1.4 by Robert Collins
Remove the explicit set_parent method on RemoteBranch in favour of inheriting from Branch.
792
    @needs_write_lock
5718.8.6 by Jelmer Vernooij
Move generate_revision_history.
793
    def generate_revision_history(self, revision_id, last_rev=None,
794
                                  other_branch=None):
5718.8.18 by Jelmer Vernooij
Translate local set_rh calls to remote set_rh calls.
795
        """See Branch.generate_revision_history"""
5718.8.24 by Jelmer Vernooij
Implement generate_revision_history using graph.
796
        graph = self.repository.get_graph()
6015.18.1 by Jelmer Vernooij
Fix entry in known_revnos for generate_revision_history.
797
        (last_revno, last_revid) = self.last_revision_info()
5718.8.24 by Jelmer Vernooij
Implement generate_revision_history using graph.
798
        known_revision_ids = [
6015.18.1 by Jelmer Vernooij
Fix entry in known_revnos for generate_revision_history.
799
            (last_revid, last_revno),
5718.8.24 by Jelmer Vernooij
Implement generate_revision_history using graph.
800
            (_mod_revision.NULL_REVISION, 0),
801
            ]
802
        if last_rev is not None:
803
            if not graph.is_ancestor(last_rev, revision_id):
804
                # our previous tip is not merged into stop_revision
805
                raise errors.DivergedBranches(self, other_branch)
806
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
5718.8.6 by Jelmer Vernooij
Move generate_revision_history.
807
        self.set_last_revision_info(revno, revision_id)
808
809
    @needs_write_lock
4288.1.4 by Robert Collins
Remove the explicit set_parent method on RemoteBranch in favour of inheriting from Branch.
810
    def set_parent(self, url):
811
        """See Branch.set_parent."""
812
        # TODO: Maybe delete old location files?
813
        # URLs should never be unicode, even on the local fs,
814
        # FIXUP this and get_parent in a future branch format bump:
815
        # read and rewrite the file. RBC 20060125
816
        if url is not None:
817
            if isinstance(url, unicode):
818
                try:
819
                    url = url.encode('ascii')
820
                except UnicodeEncodeError:
821
                    raise errors.InvalidURL(url,
822
                        "Urls must be 7-bit ascii, "
823
                        "use bzrlib.urlutils.escape")
824
            url = urlutils.relative_url(self.base, url)
825
        self._set_parent_location(url)
826
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
827
    @needs_write_lock
3537.3.3 by Martin Pool
Rename Branch.set_stacked_on to set_stacked_on_url
828
    def set_stacked_on_url(self, url):
3221.18.1 by Ian Clatworthy
tweaks by ianc during review
829
        """Set the URL this branch is stacked against.
3221.11.2 by Robert Collins
Create basic stackable branch facility.
830
831
        :raises UnstackableBranchFormat: If the branch does not support
832
            stacking.
833
        :raises UnstackableRepositoryFormat: If the repository does not support
834
            stacking.
835
        """
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
836
        if not self._format.supports_stacking():
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
837
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
4509.3.30 by Martin Pool
doc
838
        # XXX: Changing from one fallback repository to another does not check
839
        # that all the data you need is present in the new fallback.
840
        # Possibly it should.
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
841
        self._check_stackable_repo()
842
        if not url:
843
            try:
4509.3.9 by Martin Pool
Split out Branch._unstack
844
                old_url = self.get_stacked_on_url()
845
            except (errors.NotStacked, errors.UnstackableBranchFormat,
846
                errors.UnstackableRepositoryFormat):
847
                return
848
            self._unstack()
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
849
        else:
4379.2.2 by John Arbash Meinel
Change the Repository.add_fallback_repository() contract slightly.
850
            self._activate_fallback_location(url)
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
851
        # write this out after the repository is stacked to avoid setting a
852
        # stacked config that doesn't work.
853
        self._set_config_location('stacked_on_location', url)
854
4509.3.9 by Martin Pool
Split out Branch._unstack
855
    def _unstack(self):
856
        """Change a branch to be unstacked, copying data as needed.
5697.2.1 by Jelmer Vernooij
Move weave branch to bzrlib.branch_weave.
857
4509.3.9 by Martin Pool
Split out Branch._unstack
858
        Don't call this directly, use set_stacked_on_url(None).
859
        """
860
        pb = ui.ui_factory.nested_progress_bar()
861
        try:
6138.4.1 by Jonathan Riddell
add gettext to progress bar strings
862
            pb.update(gettext("Unstacking"))
4509.3.16 by Martin Pool
Unstack by fetching from the stacked repository combination, not just the fallback.
863
            # The basic approach here is to fetch the tip of the branch,
864
            # including all available ghosts, from the existing stacked
865
            # repository into a new repository object without the fallbacks. 
866
            #
867
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
868
            # correct for CHKMap repostiories
869
            old_repository = self.repository
870
            if len(old_repository._fallback_repositories) != 1:
4509.3.9 by Martin Pool
Split out Branch._unstack
871
                raise AssertionError("can't cope with fallback repositories "
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
872
                    "of %r (fallbacks: %r)" % (old_repository,
873
                        old_repository._fallback_repositories))
5325.1.3 by Andrew Bennetts
Try harder to preserve lock-count in _unstack, and add special-case to replace self._real_branch.repository as well as self.repository for remote branches.
874
            # Open the new repository object.
875
            # Repositories don't offer an interface to remove fallback
876
            # repositories today; take the conceptually simpler option and just
877
            # reopen it.  We reopen it starting from the URL so that we
878
            # get a separate connection for RemoteRepositories and can
879
            # stream from one of them to the other.  This does mean doing
880
            # separate SSH connection setup, but unstacking is not a
881
            # common operation so it's tolerable.
882
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
883
            new_repository = new_bzrdir.find_repository()
884
            if new_repository._fallback_repositories:
885
                raise AssertionError("didn't expect %r to have "
886
                    "fallback_repositories"
887
                    % (self.repository,))
5325.1.4 by Andrew Bennetts
Improve comments.
888
            # Replace self.repository with the new repository.
889
            # Do our best to transfer the lock state (i.e. lock-tokens and
5325.1.3 by Andrew Bennetts
Try harder to preserve lock-count in _unstack, and add special-case to replace self._real_branch.repository as well as self.repository for remote branches.
890
            # lock count) of self.repository to the new repository.
891
            lock_token = old_repository.lock_write().repository_token
892
            self.repository = new_repository
893
            if isinstance(self, remote.RemoteBranch):
5325.1.4 by Andrew Bennetts
Improve comments.
894
                # Remote branches can have a second reference to the old
895
                # repository that need to be replaced.
5325.1.3 by Andrew Bennetts
Try harder to preserve lock-count in _unstack, and add special-case to replace self._real_branch.repository as well as self.repository for remote branches.
896
                if self._real_branch is not None:
897
                    self._real_branch.repository = new_repository
898
            self.repository.lock_write(token=lock_token)
899
            if lock_token is not None:
900
                old_repository.leave_lock_in_place()
4509.3.16 by Martin Pool
Unstack by fetching from the stacked repository combination, not just the fallback.
901
            old_repository.unlock()
5325.1.3 by Andrew Bennetts
Try harder to preserve lock-count in _unstack, and add special-case to replace self._real_branch.repository as well as self.repository for remote branches.
902
            if lock_token is not None:
903
                # XXX: self.repository.leave_lock_in_place() before this
904
                # function will not be preserved.  Fortunately that doesn't
5325.1.4 by Andrew Bennetts
Improve comments.
905
                # affect the current default format (2a), and would be a
906
                # corner-case anyway.
5325.1.3 by Andrew Bennetts
Try harder to preserve lock-count in _unstack, and add special-case to replace self._real_branch.repository as well as self.repository for remote branches.
907
                #  - Andrew Bennetts, 2010/06/30
908
                self.repository.dont_leave_lock_in_place()
909
            old_lock_count = 0
910
            while True:
911
                try:
912
                    old_repository.unlock()
913
                except errors.LockNotHeld:
914
                    break
915
                old_lock_count += 1
916
            if old_lock_count == 0:
917
                raise AssertionError(
918
                    'old_repository should have been locked at least once.')
919
            for i in range(old_lock_count-1):
920
                self.repository.lock_write()
921
            # Fetch from the old repository into the new.
4509.3.16 by Martin Pool
Unstack by fetching from the stacked repository combination, not just the fallback.
922
            old_repository.lock_read()
923
            try:
924
                # XXX: If you unstack a branch while it has a working tree
925
                # with a pending merge, the pending-merged revisions will no
926
                # longer be present.  You can (probably) revert and remerge.
5651.5.1 by Andrew Bennetts
Make 'bzr reconfigure --unstacked' fetch tagged revisions too. (#401646)
927
                try:
928
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
929
                except errors.TagsNotSupported:
930
                    tags_to_fetch = set()
931
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
932
                    old_repository, required_ids=[self.last_revision()],
933
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
934
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
4509.3.16 by Martin Pool
Unstack by fetching from the stacked repository combination, not just the fallback.
935
            finally:
936
                old_repository.unlock()
4509.3.9 by Martin Pool
Split out Branch._unstack
937
        finally:
938
            pb.finished()
3221.11.2 by Robert Collins
Create basic stackable branch facility.
939
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
940
    def _set_tags_bytes(self, bytes):
941
        """Mirror method for _get_tags_bytes.
942
943
        :seealso: Branch._get_tags_bytes.
944
        """
5915.1.1 by Andrew Bennetts
Removed bzrlib.branch._run_with_write_locked_target. Use bzrlib.cleanup instead.
945
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
946
        op.add_cleanup(self.lock_write().unlock)
947
        return op.run_simple(bytes)
5535.2.3 by Andrew Bennetts
Reset cached tags when mutating tags.
948
949
    def _set_tags_bytes_locked(self, bytes):
950
        self._tags_bytes = bytes
951
        return self._transport.put_bytes('tags', bytes)
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
952
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
953
    def _cache_revision_history(self, rev_history):
954
        """Set the cached revision history to rev_history.
955
956
        The revision_history method will use this cache to avoid regenerating
957
        the revision history.
958
959
        This API is semi-public; it only for use by subclasses, all other code
960
        should consider it to be private.
961
        """
962
        self._revision_history_cache = rev_history
963
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
964
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
965
        """Set the cached revision_id => revno map to revision_id_to_revno.
966
967
        This API is semi-public; it only for use by subclasses, all other code
968
        should consider it to be private.
969
        """
970
        self._revision_id_to_revno_cache = revision_id_to_revno
971
2375.1.6 by Andrew Bennetts
Rename _clear_cached_data to _clear_cached_state.
972
    def _clear_cached_state(self):
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
973
        """Clear any cached data on this branch, e.g. cached revision history.
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
974
975
        This means the next call to revision_history will need to call
976
        _gen_revision_history.
977
978
        This API is semi-public; it only for use by subclasses, all other code
979
        should consider it to be private.
980
        """
981
        self._revision_history_cache = None
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
982
        self._revision_id_to_revno_cache = None
3441.5.27 by Andrew Bennetts
Tweaks suggested by John's review: rename _check_if_descendant_or_diverged, move caching last_revision_info into base Branch, better use of lock decorators.
983
        self._last_revision_info_cache = None
5609.25.3 by Andrew Bennetts
Alternative fix: cache the result of get_master_branch for the lifetime of the branch lock.
984
        self._master_branch_cache = None
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
985
        self._merge_sorted_revisions_cache = None
4419.2.1 by Andrew Bennetts
Move _extend_partial_history into Branch base class, and use it in get_rev_id rather than self.revision_history().
986
        self._partial_revision_history_cache = []
987
        self._partial_revision_id_to_revno_cache = {}
5535.2.1 by Andrew Bennetts
Cache a branch's tags during a read-lock.
988
        self._tags_bytes = None
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
989
990
    def _gen_revision_history(self):
991
        """Return sequence of revision hashes on to this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
992
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
993
        Unlike revision_history, this method always regenerates or rereads the
994
        revision history, i.e. it does not cache the result, so repeated calls
995
        may be expensive.
996
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
997
        Concrete subclasses should override this instead of revision_history so
998
        that subclasses do not need to deal with caching logic.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
999
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
1000
        This API is semi-public; it only for use by subclasses, all other code
1001
        should consider it to be private.
1002
        """
1003
        raise NotImplementedError(self._gen_revision_history)
1004
1005
    @needs_read_lock
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1006
    def revision_history(self):
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
1007
        """Return sequence of revision ids on this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1008
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
1009
        This method will cache the revision history for as long as it is safe to
1010
        do so.
1011
        """
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
1012
        if 'evil' in debug.debug_flags:
1013
            mutter_callsite(3, "revision_history scales with history.")
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
1014
        if self._revision_history_cache is not None:
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
1015
            history = self._revision_history_cache
1016
        else:
1017
            history = self._gen_revision_history()
1018
            self._cache_revision_history(history)
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
1019
        return list(history)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1020
1021
    def revno(self):
1022
        """Return current revision number for this branch.
1023
1024
        That is equivalent to the number of revisions committed to
1025
        this branch.
1026
        """
3066.1.1 by John Arbash Meinel
Make the default Branch.revno() implementation just be a thunk to last_revision_info.
1027
        return self.last_revision_info()[0]
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1028
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1029
    def unbind(self):
1030
        """Older format branches cannot bind or unbind."""
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
1031
        raise errors.UpgradeRequired(self.user_url)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1032
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1033
    def last_revision(self):
3211.2.1 by Robert Collins
* Creating a new branch no longer tries to read the entire revision-history
1034
        """Return last revision id, or NULL_REVISION."""
1035
        return self.last_revision_info()[1]
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1036
3441.5.27 by Andrew Bennetts
Tweaks suggested by John's review: rename _check_if_descendant_or_diverged, move caching last_revision_info into base Branch, better use of lock decorators.
1037
    @needs_read_lock
2249.4.1 by Wouter van Heyst
New Branch.last_revision_info method, this is being done to allow
1038
    def last_revision_info(self):
1039
        """Return information about the last revision.
1040
3441.5.27 by Andrew Bennetts
Tweaks suggested by John's review: rename _check_if_descendant_or_diverged, move caching last_revision_info into base Branch, better use of lock decorators.
1041
        :return: A tuple (revno, revision_id).
2249.4.1 by Wouter van Heyst
New Branch.last_revision_info method, this is being done to allow
1042
        """
3441.5.27 by Andrew Bennetts
Tweaks suggested by John's review: rename _check_if_descendant_or_diverged, move caching last_revision_info into base Branch, better use of lock decorators.
1043
        if self._last_revision_info_cache is None:
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
1044
            self._last_revision_info_cache = self._read_last_revision_info()
3441.5.27 by Andrew Bennetts
Tweaks suggested by John's review: rename _check_if_descendant_or_diverged, move caching last_revision_info into base Branch, better use of lock decorators.
1045
        return self._last_revision_info_cache
1046
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
1047
    def _read_last_revision_info(self):
5718.8.3 by Jelmer Vernooij
More branch restructuring.
1048
        raise NotImplementedError(self._read_last_revision_info)
2249.4.1 by Wouter van Heyst
New Branch.last_revision_info method, this is being done to allow
1049
5809.2.1 by Jelmer Vernooij
Deprecate Branch.update_revisions.
1050
    @deprecated_method(deprecated_in((2, 4, 0)))
4048.2.2 by Jelmer Vernooij
New Branch.import_last_Revision_info() function used to pull revisions into the master branch during commit.
1051
    def import_last_revision_info(self, source_repo, revno, revid):
1052
        """Set the last revision info, importing from another repo if necessary.
1053
1054
        :param source_repo: Source repository to optionally fetch from
1055
        :param revno: Revision number of the new tip
1056
        :param revid: Revision id of the new tip
1057
        """
1058
        if not self.repository.has_same_location(source_repo):
1059
            self.repository.fetch(source_repo, revision_id=revid)
1060
        self.set_last_revision_info(revno, revid)
1061
5777.7.1 by Jelmer Vernooij
Add lossy argument to Branch.import_last_revision_info_and_tags.
1062
    def import_last_revision_info_and_tags(self, source, revno, revid,
1063
                                           lossy=False):
5535.3.31 by Andrew Bennetts
Cope with tags that reference missing revisions.
1064
        """Set the last revision info, importing from another repo if necessary.
1065
1066
        This is used by the bound branch code to upload a revision to
1067
        the master branch first before updating the tip of the local branch.
1068
        Revisions referenced by source's tags are also transferred.
1069
5535.3.35 by Andrew Bennetts
Fix deprecation warning from some tests, correct some docstrings.
1070
        :param source: Source branch to optionally fetch from
5535.3.31 by Andrew Bennetts
Cope with tags that reference missing revisions.
1071
        :param revno: Revision number of the new tip
1072
        :param revid: Revision id of the new tip
5777.7.1 by Jelmer Vernooij
Add lossy argument to Branch.import_last_revision_info_and_tags.
1073
        :param lossy: Whether to discard metadata that can not be
1074
            natively represented
1075
        :return: Tuple with the new revision number and revision id
1076
            (should only be different from the arguments when lossy=True)
5535.3.31 by Andrew Bennetts
Cope with tags that reference missing revisions.
1077
        """
1078
        if not self.repository.has_same_location(source.repository):
5741.1.8 by Jelmer Vernooij
Remove fetch_tags argument.
1079
            self.fetch(source, revid)
5535.3.31 by Andrew Bennetts
Cope with tags that reference missing revisions.
1080
        self.set_last_revision_info(revno, revid)
5777.7.1 by Jelmer Vernooij
Add lossy argument to Branch.import_last_revision_info_and_tags.
1081
        return (revno, revid)
5535.3.31 by Andrew Bennetts
Cope with tags that reference missing revisions.
1082
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1083
    def revision_id_to_revno(self, revision_id):
1084
        """Given a revision id, return its revno"""
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
1085
        if _mod_revision.is_null(revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1086
            return 0
1087
        history = self.revision_history()
1088
        try:
1089
            return history.index(revision_id) + 1
1090
        except ValueError:
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
1091
            raise errors.NoSuchRevision(self, revision_id)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1092
4419.2.1 by Andrew Bennetts
Move _extend_partial_history into Branch base class, and use it in get_rev_id rather than self.revision_history().
1093
    @needs_read_lock
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1094
    def get_rev_id(self, revno, history=None):
1095
        """Find the revision id of the specified revno."""
1096
        if revno == 0:
2598.5.10 by Aaron Bentley
Return NULL_REVISION instead of None for the null revision
1097
            return _mod_revision.NULL_REVISION
4419.2.1 by Andrew Bennetts
Move _extend_partial_history into Branch base class, and use it in get_rev_id rather than self.revision_history().
1098
        last_revno, last_revid = self.last_revision_info()
1099
        if revno == last_revno:
1100
            return last_revid
1101
        if revno <= 0 or revno > last_revno:
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
1102
            raise errors.NoSuchRevision(self, revno)
4419.2.1 by Andrew Bennetts
Move _extend_partial_history into Branch base class, and use it in get_rev_id rather than self.revision_history().
1103
        distance_from_last = last_revno - revno
1104
        if len(self._partial_revision_history_cache) <= distance_from_last:
4419.2.17 by Andrew Bennetts
Fix test failures in test_lookup_revision_id_by_dotted.
1105
            self._extend_partial_history(distance_from_last)
1106
        return self._partial_revision_history_cache[distance_from_last]
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1107
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
1108
    def pull(self, source, overwrite=False, stop_revision=None,
4000.5.21 by Jelmer Vernooij
Merge bzr.dev.
1109
             possible_transports=None, *args, **kwargs):
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1110
        """Mirror source into this branch.
1111
1112
        This branch is considered to be 'local', having low latency.
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
1113
1114
        :returns: PullResult instance
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1115
        """
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
1116
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1117
            stop_revision=stop_revision,
1118
            possible_transports=possible_transports, *args, **kwargs)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1119
5853.2.2 by Jelmer Vernooij
Make lossy_push an argument to InterBranch.push.
1120
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1121
            *args, **kwargs):
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1122
        """Mirror this branch into target.
1123
1124
        This branch is considered to be 'local', having low latency.
1125
        """
4211.1.3 by Jelmer Vernooij
Fix trailing whitespace, add prototype for InterBranch.push().
1126
        return InterBranch.get(self, target).push(overwrite, stop_revision,
5853.2.2 by Jelmer Vernooij
Make lossy_push an argument to InterBranch.push.
1127
            lossy, *args, **kwargs)
4347.2.1 by Jelmer Vernooij
Move dpush onto an InterBranch object.
1128
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1129
    def basis_tree(self):
1852.5.1 by Robert Collins
Deprecate EmptyTree in favour of using Repository.revision_tree.
1130
        """Return `Tree` object for last revision."""
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
1131
        return self.repository.revision_tree(self.last_revision())
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1132
1133
    def get_parent(self):
1134
        """Return the parent location of the branch.
1135
4031.1.1 by Alexander Belchenko
Parent location is not used as default for push.
1136
        This is the default location for pull/missing.  The usual
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1137
        pattern is that the user can override it by specifying a
1138
        location.
1139
        """
4078.2.1 by Robert Collins
Add a Branch.get_parent remote call for RemoteBranch.
1140
        parent = self._get_parent_location()
1141
        if parent is None:
1142
            return parent
1143
        # This is an old-format absolute path to a local branch
1144
        # turn it into a url
1145
        if parent.startswith('/'):
1146
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1147
        try:
1148
            return urlutils.join(self.base[:-1], parent)
1149
        except errors.InvalidURLJoin, e:
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
1150
            raise errors.InaccessibleParent(parent, self.user_url)
4078.2.1 by Robert Collins
Add a Branch.get_parent remote call for RemoteBranch.
1151
1152
    def _get_parent_location(self):
1153
        raise NotImplementedError(self._get_parent_location)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1154
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
1155
    def _set_config_location(self, name, url, config=None,
1156
                             make_relative=False):
1157
        if config is None:
1158
            config = self.get_config()
1159
        if url is None:
1160
            url = ''
1161
        elif make_relative:
1162
            url = urlutils.relative_url(self.base, url)
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
1163
        config.set_user_option(name, url, warn_masked=True)
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
1164
1165
    def _get_config_location(self, name, config=None):
1166
        if config is None:
1167
            config = self.get_config()
1168
        location = config.get_user_option(name)
1169
        if location == '':
1170
            location = None
1171
        return location
1172
4382.3.1 by Jelmer Vernooij
Add Branch.get_child_submit_format(), so particular Branch implementations
1173
    def get_child_submit_format(self):
1174
        """Return the preferred format of submissions to this branch."""
1175
        return self.get_config().get_user_option("child_submit_format")
1176
1804.1.1 by Aaron Bentley
Add support for submit location to bundles
1177
    def get_submit_branch(self):
1178
        """Return the submit location of the branch.
1179
1180
        This is the default location for bundle.  The usual
1181
        pattern is that the user can override it by specifying a
1182
        location.
1183
        """
1184
        return self.get_config().get_user_option('submit_branch')
1185
1186
    def set_submit_branch(self, location):
1187
        """Return the submit location of the branch.
1188
1189
        This is the default location for bundle.  The usual
1190
        pattern is that the user can override it by specifying a
1191
        location.
1192
        """
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
1193
        self.get_config().set_user_option('submit_branch', location,
1194
            warn_masked=True)
1804.1.1 by Aaron Bentley
Add support for submit location to bundles
1195
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
1196
    def get_public_branch(self):
1197
        """Return the public location of the branch.
1198
4031.3.1 by Frank Aspell
Fixing various typos
1199
        This is used by merge directives.
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
1200
        """
1201
        return self._get_config_location('public_branch')
1202
1203
    def set_public_branch(self, location):
1204
        """Return the submit location of the branch.
1205
1206
        This is the default location for bundle.  The usual
1207
        pattern is that the user can override it by specifying a
1208
        location.
1209
        """
1210
        self._set_config_location('public_branch', location)
1211
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1212
    def get_push_location(self):
1213
        """Return the None or the location to push this branch to."""
2018.5.59 by Robert Collins
Get BranchConfig working somewhat on RemoteBranches (Robert Collins, Vincent Ladeuil).
1214
        push_loc = self.get_config().get_user_option('push_location')
1215
        return push_loc
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1216
1217
    def set_push_location(self, location):
1218
        """Set a new push location for this branch."""
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
1219
        raise NotImplementedError(self.set_push_location)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1220
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
1221
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1222
        """Run the post_change_branch_tip hooks."""
1223
        hooks = Branch.hooks['post_change_branch_tip']
1224
        if not hooks:
1225
            return
1226
        new_revno, new_revid = self.last_revision_info()
1227
        params = ChangeBranchTipParams(
1228
            self, old_revno, new_revno, old_revid, new_revid)
1229
        for hook in hooks:
1230
            hook(params)
1231
1232
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1233
        """Run the pre_change_branch_tip hooks."""
1234
        hooks = Branch.hooks['pre_change_branch_tip']
1235
        if not hooks:
1236
            return
1237
        old_revno, old_revid = self.last_revision_info()
1238
        params = ChangeBranchTipParams(
1239
            self, old_revno, new_revno, old_revid, new_revid)
1240
        for hook in hooks:
4943.1.1 by Robert Collins
Do not fiddle with exceptions in the pre_change_branch_tip hook running code.
1241
            hook(params)
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
1242
1587.1.10 by Robert Collins
update updates working tree and branch together.
1243
    @needs_write_lock
1244
    def update(self):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1245
        """Synchronise this branch with the master branch if any.
1587.1.10 by Robert Collins
update updates working tree and branch together.
1246
1247
        :return: None or the last_revision pivoted out during the update.
1248
        """
1249
        return None
1250
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1251
    def check_revno(self, revno):
1252
        """\
1253
        Check whether a revno corresponds to any revision.
1254
        Zero (the NULL revision) is considered valid.
1255
        """
1256
        if revno != 0:
1257
            self.check_real_revno(revno)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1258
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1259
    def check_real_revno(self, revno):
1260
        """\
1261
        Check whether a revno corresponds to a real revision.
1262
        Zero (the NULL revision) is considered invalid
1263
        """
1264
        if revno < 1 or revno > self.revno():
3236.1.2 by Michael Hudson
clean up branch.py imports
1265
            raise errors.InvalidRevisionNumber(revno)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1266
1267
    @needs_read_lock
4050.1.1 by Robert Collins
Fix race condition with branch hooks during cloning when the new branch is stacked.
1268
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1269
        """Clone this branch into to_bzrdir preserving all semantic values.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1270
4044.1.1 by Robert Collins
Create Branch.create_clone_on_transport helper method to combine bzr and branch creation for push.
1271
        Most API users will want 'create_clone_on_transport', which creates a
1272
        new bzrdir and branch on the fly.
1273
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1274
        revision_id: if not None, the revision history in the new branch will
1275
                     be truncated to end with revision_id.
1276
        """
3650.5.1 by Aaron Bentley
Fix push to use clone all the time.
1277
        result = to_bzrdir.create_branch()
4288.1.8 by Robert Collins
Lock new branches while we configure them in clone and sprout for less lock churn.
1278
        result.lock_write()
1279
        try:
1280
            if repository_policy is not None:
1281
                repository_policy.configure_branch(result)
1282
            self.copy_content_into(result, revision_id=revision_id)
1283
        finally:
1284
            result.unlock()
1285
        return result
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1286
1287
    @needs_read_lock
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
1288
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1289
            repository=None):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1290
        """Create a new line of development from the branch, into to_bzrdir.
3650.2.1 by Aaron Bentley
Fix sprout to honour cloning format
1291
1292
        to_bzrdir controls the branch format.
1293
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1294
        revision_id: if not None, the revision history in the new branch will
1295
                     be truncated to end with revision_id.
1296
        """
4617.3.1 by Robert Collins
Fix test_stacking tests for 2a as a default format. The change to 2a exposed some actual bugs, both in tests and bzrdir/branch code.
1297
        if (repository_policy is not None and
1298
            repository_policy.requires_stacking()):
1299
            to_bzrdir._format.require_stacking(_skip_repo=True)
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
1300
        result = to_bzrdir.create_branch(repository=repository)
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
1301
        result.lock_write()
4288.1.8 by Robert Collins
Lock new branches while we configure them in clone and sprout for less lock churn.
1302
        try:
1303
            if repository_policy is not None:
1304
                repository_policy.configure_branch(result)
1305
            self.copy_content_into(result, revision_id=revision_id)
6015.7.1 by John Arbash Meinel
No need to open the master branch just to get its URL.
1306
            master_url = self.get_bound_location()
1307
            if master_url is None:
5816.6.13 by A. S. Budden
Set the parent location to the branch to which we were bound if this is a bound branch.
1308
                result.set_parent(self.bzrdir.root_transport.base)
1309
            else:
6015.7.1 by John Arbash Meinel
No need to open the master branch just to get its URL.
1310
                result.set_parent(master_url)
4288.1.8 by Robert Collins
Lock new branches while we configure them in clone and sprout for less lock churn.
1311
        finally:
1312
            result.unlock()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1313
        return result
1314
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
1315
    def _synchronize_history(self, destination, revision_id):
2230.3.35 by Aaron Bentley
Add documentation for synchonize_history
1316
        """Synchronize last revision and revision history between branches.
1317
1318
        This version is most efficient when the destination is also a
3834.3.1 by Andrew Bennetts
Get rid of revision_history() call during copy_content_into.
1319
        BzrBranch6, but works for BzrBranch5, as long as the destination's
1320
        repository contains all the lefthand ancestors of the intended
1321
        last_revision.  If not, set_last_revision_info will fail.
2230.3.35 by Aaron Bentley
Add documentation for synchonize_history
1322
1323
        :param destination: The branch to copy the history into
1324
        :param revision_id: The revision-id to truncate history at.  May
1325
          be None to copy complete history.
1326
        """
3834.3.1 by Andrew Bennetts
Get rid of revision_history() call during copy_content_into.
1327
        source_revno, source_revision_id = self.last_revision_info()
1328
        if revision_id is None:
1329
            revno, revision_id = source_revno, source_revision_id
3650.3.3 by Aaron Bentley
fix sprout
1330
        else:
4266.3.8 by Jelmer Vernooij
Consistently use find_distance_to_null.
1331
            graph = self.repository.get_graph()
4266.3.1 by Jelmer Vernooij
Support cloning of branches with ghosts in the left hand side history.
1332
            try:
4266.3.8 by Jelmer Vernooij
Consistently use find_distance_to_null.
1333
                revno = graph.find_distance_to_null(revision_id, 
1334
                    [(source_revision_id, source_revno)])
1335
            except errors.GhostRevisionsHaveNoRevno:
1336
                # Default to 1, if we can't find anything else
1337
                revno = 1
3834.3.1 by Andrew Bennetts
Get rid of revision_history() call during copy_content_into.
1338
        destination.set_last_revision_info(revno, revision_id)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1339
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1340
    def copy_content_into(self, destination, revision_id=None):
1341
        """Copy the content of self into destination.
1342
1343
        revision_id: if not None, the revision history in the new branch will
1344
                     be truncated to end with revision_id.
1345
        """
5284.4.2 by Robert Collins
* ``Branch.copy_content_into`` is now a convenience method dispatching to
1346
        return InterBranch.get(self, destination).copy_content_into(
1347
            revision_id=revision_id)
4273.1.6 by Aaron Bentley
Ensure references are rebased.
1348
1349
    def update_references(self, target):
4273.1.8 by Aaron Bentley
Handle references in push, pull, merge.
1350
        if not getattr(self._format, 'supports_reference_locations', False):
1351
            return
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
1352
        reference_dict = self._get_all_reference_info()
4273.1.9 by Aaron Bentley
Cleanup
1353
        if len(reference_dict) == 0:
1354
            return
4273.1.6 by Aaron Bentley
Ensure references are rebased.
1355
        old_base = self.base
1356
        new_base = target.base
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
1357
        target_reference_dict = target._get_all_reference_info()
4273.1.6 by Aaron Bentley
Ensure references are rebased.
1358
        for file_id, (tree_path, branch_location) in (
1359
            reference_dict.items()):
1360
            branch_location = urlutils.rebase_url(branch_location,
1361
                                                  old_base, new_base)
4273.1.7 by Aaron Bentley
Make update_references do a merge.
1362
            target_reference_dict.setdefault(
1363
                file_id, (tree_path, branch_location))
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
1364
        target._set_all_reference_info(target_reference_dict)
1185.66.1 by Aaron Bentley
Merged from mainline
1365
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1366
    @needs_read_lock
4332.3.7 by Robert Collins
Convert Branch.check to take a refs dict as well.
1367
    def check(self, refs):
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1368
        """Check consistency of the branch.
1369
1370
        In particular this checks that revisions given in the revision-history
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1371
        do actually match up in the revision graph, and that they're all
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1372
        present in the repository.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1373
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1374
        Callers will typically also want to check the repository.
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1375
4332.3.7 by Robert Collins
Convert Branch.check to take a refs dict as well.
1376
        :param refs: Calculated refs for this branch as specified by
1377
            branch._get_check_refs()
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1378
        :return: A BranchCheckResult.
1379
        """
4332.3.3 by Robert Collins
Alter Branch.check to log errors rather than raising.
1380
        result = BranchCheckResult(self)
3389.2.1 by John Arbash Meinel
Add code to 'bzr check' to detect when the mainline history is inconsistent.
1381
        last_revno, last_revision_id = self.last_revision_info()
4332.3.7 by Robert Collins
Convert Branch.check to take a refs dict as well.
1382
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1383
        if actual_revno != last_revno:
4332.3.3 by Robert Collins
Alter Branch.check to log errors rather than raising.
1384
            result.errors.append(errors.BzrCheckError(
1385
                'revno does not match len(mainline) %s != %s' % (
4332.3.7 by Robert Collins
Convert Branch.check to take a refs dict as well.
1386
                last_revno, actual_revno)))
1387
        # TODO: We should probably also check that self.revision_history
1388
        # matches the repository for older branch formats.
1389
        # If looking for the code that cross-checks repository parents against
1390
        # the iter_reverse_revision_history output, that is now a repository
1391
        # specific check.
4332.3.3 by Robert Collins
Alter Branch.check to log errors rather than raising.
1392
        return result
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1393
6127.1.9 by Jelmer Vernooij
Add lightweight option to _get_checkout_format().
1394
    def _get_checkout_format(self, lightweight=False):
1910.2.39 by Aaron Bentley
Fix checkout bug
1395
        """Return the most suitable metadir for a checkout of this branch.
2018.5.87 by Andrew Bennetts
Make make_branch_and_tree fall back to creating a local checkout if the transport doesn't support working trees, allowing several more Remote tests to pass.
1396
        Weaves are used if this branch's repository uses weaves.
1910.2.39 by Aaron Bentley
Fix checkout bug
1397
        """
5582.10.3 by Jelmer Vernooij
Remove custom code for presplitout.
1398
        format = self.repository.bzrdir.checkout_metadir()
1399
        format.set_branch_format(self._format)
1910.2.39 by Aaron Bentley
Fix checkout bug
1400
        return format
1401
4044.1.1 by Robert Collins
Create Branch.create_clone_on_transport helper method to combine bzr and branch creation for push.
1402
    def create_clone_on_transport(self, to_transport, revision_id=None,
5448.6.1 by Matthew Gordon
Added --no-tree option to pull. Needs testing and help text.
1403
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1404
        no_tree=None):
4044.1.1 by Robert Collins
Create Branch.create_clone_on_transport helper method to combine bzr and branch creation for push.
1405
        """Create a clone of this branch and its bzrdir.
1406
1407
        :param to_transport: The transport to clone onto.
1408
        :param revision_id: The revision id to use as tip in the new branch.
1409
            If None the tip is obtained from this branch.
1410
        :param stacked_on: An optional URL to stack the clone on.
4294.2.1 by Robert Collins
Move directory checking for bzr push options into Branch.create_clone_on_transport.
1411
        :param create_prefix: Create any missing directories leading up to
1412
            to_transport.
1413
        :param use_existing_dir: Use an existing directory if one exists.
4044.1.1 by Robert Collins
Create Branch.create_clone_on_transport helper method to combine bzr and branch creation for push.
1414
        """
4044.1.2 by Robert Collins
Reinstate the TODO comment about bzrdir.clone_on_transport.
1415
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1416
        # clone call. Or something. 20090224 RBC/spiv.
5147.4.1 by Jelmer Vernooij
Pass branch names in more places.
1417
        # XXX: Should this perhaps clone colocated branches as well, 
1418
        # rather than just the default branch? 20100319 JRV
4294.2.1 by Robert Collins
Move directory checking for bzr push options into Branch.create_clone_on_transport.
1419
        if revision_id is None:
1420
            revision_id = self.last_revision()
4634.105.1 by Andrew Bennetts
Fix traceback when doing 'bzr push --use-existing-dir' into a dir with an invalid .bzr directory.
1421
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1422
            revision_id=revision_id, stacked_on=stacked_on,
5448.6.1 by Matthew Gordon
Added --no-tree option to pull. Needs testing and help text.
1423
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
5448.6.2 by Matthew Gordon
Tested push --no-tree ang gor it working right.
1424
            no_tree=no_tree)
4044.1.1 by Robert Collins
Create Branch.create_clone_on_transport helper method to combine bzr and branch creation for push.
1425
        return dir_to.open_branch()
1426
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1427
    def create_checkout(self, to_location, revision_id=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1428
                        lightweight=False, accelerator_tree=None,
1429
                        hardlink=False):
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1430
        """Create a checkout of a branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1431
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1432
        :param to_location: The url to produce the checkout at
1433
        :param revision_id: The revision to check out
1551.8.5 by Aaron Bentley
Change name to create_checkout
1434
        :param lightweight: If True, produce a lightweight checkout, otherwise,
5891.1.3 by Andrew Bennetts
Move docstring formatting fixes.
1435
            produce a bound branch (heavyweight checkout)
3123.5.17 by Aaron Bentley
Update docs
1436
        :param accelerator_tree: A tree which can be used for retrieving file
1437
            contents more quickly than the revision tree, i.e. a workingtree.
1438
            The revision tree will be used for cases where accelerator_tree's
1439
            content is different.
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1440
        :param hardlink: If true, hard-link files from accelerator_tree,
1441
            where possible.
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1442
        :return: The tree of the created checkout
1443
        """
1910.2.39 by Aaron Bentley
Fix checkout bug
1444
        t = transport.get_transport(to_location)
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
1445
        t.ensure_base()
6127.1.9 by Jelmer Vernooij
Add lightweight option to _get_checkout_format().
1446
        format = self._get_checkout_format(lightweight=lightweight)
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1447
        if lightweight:
2100.3.26 by Aaron Bentley
checkout type is maintained for subtrees
1448
            checkout = format.initialize_on_transport(t)
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
1449
            from_branch = BranchReferenceFormat().initialize(checkout, 
1450
                target_branch=self)
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1451
        else:
1452
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1910.2.39 by Aaron Bentley
Fix checkout bug
1453
                to_location, force_new_tree=False, format=format)
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1454
            checkout = checkout_branch.bzrdir
1455
            checkout_branch.bind(self)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1456
            # pull up to the specified revision_id to set the initial
1997.1.5 by Robert Collins
``Branch.bind(other_branch)`` no longer takes a write lock on the
1457
            # branch tip correctly, and seed it with history.
1458
            checkout_branch.pull(self, stop_revision=revision_id)
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
1459
            from_branch=None
1460
        tree = checkout.create_workingtree(revision_id,
3123.5.2 by Aaron Bentley
Allow checkout --files_from
1461
                                           from_branch=from_branch,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1462
                                           accelerator_tree=accelerator_tree,
1463
                                           hardlink=hardlink)
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
1464
        basis_tree = tree.basis_tree()
1465
        basis_tree.lock_read()
1466
        try:
1467
            for path, file_id in basis_tree.iter_references():
1468
                reference_parent = self.reference_parent(file_id, path)
1469
                reference_parent.create_checkout(tree.abspath(path),
1470
                    basis_tree.get_reference_revision(file_id, path),
1471
                    lightweight)
1472
        finally:
1473
            basis_tree.unlock()
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
1474
        return tree
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1475
3389.2.3 by John Arbash Meinel
Add Branch.reconcile() functionality.
1476
    @needs_write_lock
1477
    def reconcile(self, thorough=True):
1478
        """Make sure the data stored in this branch is consistent."""
1479
        from bzrlib.reconcile import BranchReconciler
1480
        reconciler = BranchReconciler(self, thorough=thorough)
1481
        reconciler.reconcile()
1482
        return reconciler
1483
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
1484
    def reference_parent(self, file_id, path, possible_transports=None):
2100.3.29 by Aaron Bentley
Get merge working initially
1485
        """Return the parent branch for a tree-reference file_id
5891.1.2 by Andrew Bennetts
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.
1486
2100.3.29 by Aaron Bentley
Get merge working initially
1487
        :param file_id: The file_id of the tree reference
1488
        :param path: The path of the file_id in the tree
1489
        :return: A branch associated with the file_id
1490
        """
1491
        # FIXME should provide multiple branches, based on config
5158.6.11 by Martin Pool
Revert some fragile dependencies of branch on .base
1492
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
5158.6.8 by Martin Pool
Go back to opening branch using url, so it can use all possible transports
1493
                           possible_transports=possible_transports)
2100.3.23 by Aaron Bentley
Nested checkouts kinda work
1494
2220.2.30 by Martin Pool
split out tag-merging code and add some tests
1495
    def supports_tags(self):
1496
        return self._format.supports_tags()
1497
5086.4.7 by Jelmer Vernooij
Put automatic_tag_name on Branch.
1498
    def automatic_tag_name(self, revision_id):
1499
        """Try to automatically find the tag name for a revision.
1500
1501
        :param revision_id: Revision id of the revision.
5086.4.8 by Jelmer Vernooij
Review comments from Ian.
1502
        :return: A tag name or None if no tag name could be determined.
5086.4.7 by Jelmer Vernooij
Put automatic_tag_name on Branch.
1503
        """
1504
        for hook in Branch.hooks['automatic_tag_name']:
1505
            ret = hook(self, revision_id)
1506
            if ret is not None:
1507
                return ret
1508
        return None
1509
3441.5.27 by Andrew Bennetts
Tweaks suggested by John's review: rename _check_if_descendant_or_diverged, move caching last_revision_info into base Branch, better use of lock decorators.
1510
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1511
                                         other_branch):
3441.5.18 by Andrew Bennetts
Fix some test failures.
1512
        """Ensure that revision_b is a descendant of revision_a.
1513
1514
        This is a helper function for update_revisions.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1515
3441.5.18 by Andrew Bennetts
Fix some test failures.
1516
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1517
        :returns: True if revision_b is a descendant of revision_a.
1518
        """
1519
        relation = self._revision_relations(revision_a, revision_b, graph)
1520
        if relation == 'b_descends_from_a':
1521
            return True
1522
        elif relation == 'diverged':
1523
            raise errors.DivergedBranches(self, other_branch)
1524
        elif relation == 'a_descends_from_b':
1525
            return False
1526
        else:
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
1527
            raise AssertionError("invalid relation: %r" % (relation,))
3441.5.18 by Andrew Bennetts
Fix some test failures.
1528
1529
    def _revision_relations(self, revision_a, revision_b, graph):
1530
        """Determine the relationship between two revisions.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1531
3441.5.18 by Andrew Bennetts
Fix some test failures.
1532
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1533
        """
1534
        heads = graph.heads([revision_a, revision_b])
1535
        if heads == set([revision_b]):
1536
            return 'b_descends_from_a'
1537
        elif heads == set([revision_a, revision_b]):
1538
            # These branches have diverged
1539
            return 'diverged'
1540
        elif heads == set([revision_a]):
1541
            return 'a_descends_from_b'
1542
        else:
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
1543
            raise AssertionError("invalid heads: %r" % (heads,))
3441.5.18 by Andrew Bennetts
Fix some test failures.
1544
5741.1.11 by Jelmer Vernooij
Don't make heads_to_fetch() take a stop_revision.
1545
    def heads_to_fetch(self):
5672.1.1 by Andrew Bennetts
Refactor some of FetchSpecFactory into new Branch.heads_to_fetch method so that branch implementations like looms can override it.
1546
        """Return the heads that must and that should be fetched to copy this
1547
        branch into another repo.
1548
1549
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1550
            set of heads that must be fetched.  if_present_fetch is a set of
1551
            heads that must be fetched if present, but no error is necessary if
1552
            they are not present.
1553
        """
5741.1.11 by Jelmer Vernooij
Don't make heads_to_fetch() take a stop_revision.
1554
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1555
        # are the tags.
1556
        must_fetch = set([self.last_revision()])
6015.15.1 by John Arbash Meinel
Start working on a config entry for testing whether we should fetch tags or not.
1557
        if_present_fetch = set()
1558
        c = self.get_config()
1559
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1560
                                                 default=False)
1561
        if include_tags:
1562
            try:
1563
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1564
            except errors.TagsNotSupported:
1565
                pass
5672.1.1 by Andrew Bennetts
Refactor some of FetchSpecFactory into new Branch.heads_to_fetch method so that branch implementations like looms can override it.
1566
        must_fetch.discard(_mod_revision.NULL_REVISION)
1567
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1568
        return must_fetch, if_present_fetch
1569
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1570
5669.3.10 by Jelmer Vernooij
Use ControlComponentFormat.
1571
class BranchFormat(controldir.ControlComponentFormat):
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1572
    """An encapsulation of the initialization and open routines for a format.
1573
1574
    Formats provide three things:
1575
     * An initialization routine,
1576
     * a format string,
1577
     * an open routine.
1578
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1579
    Formats are placed in an dict by their format string for reference
5448.2.1 by Martin
Fix some "its" vs. "it's" spelling confusion in bzrlib code... also, ahem, a name in the NEWS file
1580
    during branch opening. It's not required that these be instances, they
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1581
    can be classes themselves with class methods - it simply depends on
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1582
    whether state is needed for a given format or not.
1583
1584
    Once a format is deprecated, just deprecate the initialize and open
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1585
    methods on the format class. Do not deprecate the object, as the
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1586
    object will be created every time regardless.
1587
    """
1588
2363.5.5 by Aaron Bentley
add info.describe_format
1589
    def __eq__(self, other):
1590
        return self.__class__ is other.__class__
1591
1592
    def __ne__(self, other):
1593
        return not (self == other)
1594
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1595
    @classmethod
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
1596
    def find_format(klass, a_bzrdir, name=None):
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1597
        """Return the format for the branch object in a_bzrdir."""
1598
        try:
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
1599
            transport = a_bzrdir.get_branch_transport(None, name=name)
4708.2.1 by Martin
Ensure all files opened by bazaar proper are explicitly closed
1600
            format_string = transport.get_bytes("format")
5662.2.6 by Jelmer Vernooij
add more tests.
1601
            return format_registry.get(format_string)
3236.1.2 by Michael Hudson
clean up branch.py imports
1602
        except errors.NoSuchFile:
4734.4.7 by Andrew Bennetts
Defer checking for a repository in NotBranchError case until we format the error as a string. (test_smart currently fails)
1603
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1604
        except KeyError:
3246.3.2 by Daniel Watkins
Modified uses of errors.UnknownFormatError.
1605
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1606
1607
    @classmethod
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
1608
    @deprecated_method(deprecated_in((2, 4, 0)))
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1609
    def get_default_format(klass):
1610
        """Return the current default format."""
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
1611
        return format_registry.get_default()
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1612
5305.1.1 by Robert Collins
``Branch`` formats can now be loaded lazily by registering a
1613
    @classmethod
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
1614
    @deprecated_method(deprecated_in((2, 4, 0)))
5305.1.1 by Robert Collins
``Branch`` formats can now be loaded lazily by registering a
1615
    def get_formats(klass):
1616
        """Get all the known formats.
1617
1618
        Warning: This triggers a load of all lazy registered formats: do not
1619
        use except when that is desireed.
1620
        """
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
1621
        return format_registry._get_all()
5305.1.1 by Robert Collins
``Branch`` formats can now be loaded lazily by registering a
1622
5147.4.6 by Jelmer Vernooij
consistency in names
1623
    def get_reference(self, a_bzrdir, name=None):
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
1624
        """Get the target reference of the branch in a_bzrdir.
1625
1626
        format probing must have been completed before calling
1627
        this method - it is assumed that the format of the branch
1628
        in a_bzrdir is correct.
1629
1630
        :param a_bzrdir: The bzrdir to get the branch data from.
5147.4.6 by Jelmer Vernooij
consistency in names
1631
        :param name: Name of the colocated branch to fetch
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
1632
        :return: None if the branch is not a reference branch.
1633
        """
1634
        return None
1635
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
1636
    @classmethod
5147.4.6 by Jelmer Vernooij
consistency in names
1637
    def set_reference(self, a_bzrdir, name, to_branch):
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
1638
        """Set the target reference of the branch in a_bzrdir.
1639
1640
        format probing must have been completed before calling
1641
        this method - it is assumed that the format of the branch
1642
        in a_bzrdir is correct.
1643
1644
        :param a_bzrdir: The bzrdir to set the branch reference for.
5147.4.6 by Jelmer Vernooij
consistency in names
1645
        :param name: Name of colocated branch to set, None for default
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
1646
        :param to_branch: branch that the checkout is to reference
1647
        """
1648
        raise NotImplementedError(self.set_reference)
1649
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1650
    def get_format_string(self):
1651
        """Return the ASCII format string that identifies this format."""
1652
        raise NotImplementedError(self.get_format_string)
1653
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
1654
    def get_format_description(self):
1655
        """Return the short format description for this format."""
2258.1.1 by Robert Collins
Move info branch statistics gathering into the repository to allow smart server optimisation (Robert Collins).
1656
        raise NotImplementedError(self.get_format_description)
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
1657
5107.3.2 by Marco Pantaleoni
Renamed 'post_branch' hook to 'post_branch_init', for more consistency,
1658
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1659
        hooks = Branch.hooks['post_branch_init']
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1660
        if not hooks:
1661
            return
5107.3.2 by Marco Pantaleoni
Renamed 'post_branch' hook to 'post_branch_init', for more consistency,
1662
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1663
        for hook in hooks:
1664
            hook(params)
1665
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
1666
    def initialize(self, a_bzrdir, name=None, repository=None,
1667
                   append_revisions_only=None):
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
1668
        """Create a branch of this format in a_bzrdir.
1669
        
1670
        :param name: Name of the colocated branch to create.
1671
        """
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
1672
        raise NotImplementedError(self.initialize)
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1673
1534.4.7 by Robert Collins
Move downlevel check up to the Branch.open logic, removing it from the Branch constructor and deprecating relax_version_check to the same.
1674
    def is_supported(self):
1675
        """Is this format supported?
1676
1677
        Supported formats can be initialized and opened.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1678
        Unsupported formats may not support initialization or committing or
1534.4.7 by Robert Collins
Move downlevel check up to the Branch.open logic, removing it from the Branch constructor and deprecating relax_version_check to the same.
1679
        some other features depending on the reason for not being supported.
1680
        """
1681
        return True
1682
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
1683
    def make_tags(self, branch):
1684
        """Create a tags object for branch.
1685
1686
        This method is on BranchFormat, because BranchFormats are reflected
1687
        over the wire via network_name(), whereas full Branch instances require
1688
        multiple VFS method calls to operate at all.
1689
1690
        The default implementation returns a disabled-tags instance.
1691
1692
        Note that it is normal for branch to be a RemoteBranch when using tags
1693
        on a RemoteBranch.
1694
        """
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
1695
        return _mod_tag.DisabledTags(branch)
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
1696
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
1697
    def network_name(self):
1698
        """A simple byte string uniquely identifying this format for RPC calls.
1699
1700
        MetaDir branch formats use their disk format string to identify the
1701
        repository over the wire. All in one formats such as bzr < 0.8, and
1702
        foreign formats like svn/git and hg should use some marker which is
1703
        unique and immutable.
1704
        """
1705
        raise NotImplementedError(self.network_name)
1706
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
1707
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1708
            found_repository=None):
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1709
        """Return the branch object for a_bzrdir
1710
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
1711
        :param a_bzrdir: A BzrDir that contains a branch.
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
1712
        :param name: Name of colocated branch to open
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
1713
        :param _found: a private parameter, do not use it. It is used to
1714
            indicate if format probing has already be done.
1715
        :param ignore_fallbacks: when set, no fallback branches will be opened
1716
            (if there are any).  Default is to open fallbacks.
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1717
        """
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1718
        raise NotImplementedError(self.open)
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1719
1720
    @classmethod
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
1721
    @deprecated_method(deprecated_in((2, 4, 0)))
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1722
    def register_format(klass, format):
5305.1.1 by Robert Collins
``Branch`` formats can now be loaded lazily by registering a
1723
        """Register a metadir format.
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
1724
5305.1.1 by Robert Collins
``Branch`` formats can now be loaded lazily by registering a
1725
        See MetaDirBranchFormatFactory for the ability to register a format
1726
        without loading the code the format needs until it is actually used.
1727
        """
5662.2.1 by Jelmer Vernooij
Add BranchFormatRegistry.
1728
        format_registry.register(format)
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1729
1534.4.7 by Robert Collins
Move downlevel check up to the Branch.open logic, removing it from the Branch constructor and deprecating relax_version_check to the same.
1730
    @classmethod
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
1731
    @deprecated_method(deprecated_in((2, 4, 0)))
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1732
    def set_default_format(klass, format):
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
1733
        format_registry.set_default(format)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1734
4301.3.3 by Andrew Bennetts
Move check onto base Branch class, and add a supports_set_append_revisions_only method to BranchFormat, as suggested by Robert.
1735
    def supports_set_append_revisions_only(self):
1736
        """True if this format supports set_append_revisions_only."""
1737
        return False
1738
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1739
    def supports_stacking(self):
1740
        """True if this format records a stacked-on branch."""
1741
        return False
1742
5674.1.1 by Jelmer Vernooij
Add supports_leave_lock flag to BranchFormat and RepositoryFormat.
1743
    def supports_leaving_lock(self):
1744
        """True if this format supports leaving locks in place."""
1745
        return False # by default
1746
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1747
    @classmethod
5662.2.6 by Jelmer Vernooij
add more tests.
1748
    @deprecated_method(deprecated_in((2, 4, 0)))
1534.4.7 by Robert Collins
Move downlevel check up to the Branch.open logic, removing it from the Branch constructor and deprecating relax_version_check to the same.
1749
    def unregister_format(klass, format):
5662.2.3 by Jelmer Vernooij
Fix tests.
1750
        format_registry.remove(format)
5642.2.1 by Jelmer Vernooij
Allow the registration of non-metadir branch formats.
1751
1553.4.8 by Michael Ellerman
Define __str__ for BranchFormat, just return the format string with the
1752
    def __str__(self):
4032.3.2 by Robert Collins
Create and use a RPC call to create branches on bzr servers rather than using VFS calls.
1753
        return self.get_format_description().rstrip()
1553.4.8 by Michael Ellerman
Define __str__ for BranchFormat, just return the format string with the
1754
2220.2.10 by Martin Pool
(broken) start moving things to branches
1755
    def supports_tags(self):
1756
        """True if this format supports tags stored in the branch"""
1757
        return False  # by default
1758
6123.4.6 by Jelmer Vernooij
Move flags to BranchFormat.
1759
    def tags_are_versioned(self):
1760
        """Whether the tag container for this branch versions tags."""
1761
        return False
1762
1763
    def supports_tags_referencing_ghosts(self):
1764
        """True if tags can reference ghost revisions."""
1765
        return True
1766
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1767
5305.1.1 by Robert Collins
``Branch`` formats can now be loaded lazily by registering a
1768
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
5305.1.2 by Robert Collins
More clarity about how to use the lazy registration feature.
1769
    """A factory for a BranchFormat object, permitting simple lazy registration.
1770
    
1771
    While none of the built in BranchFormats are lazy registered yet,
1772
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1773
    use it, and the bzr-loom plugin uses it as well (see
1774
    bzrlib.plugins.loom.formats).
1775
    """
5305.1.1 by Robert Collins
``Branch`` formats can now be loaded lazily by registering a
1776
1777
    def __init__(self, format_string, module_name, member_name):
1778
        """Create a MetaDirBranchFormatFactory.
1779
1780
        :param format_string: The format string the format has.
1781
        :param module_name: Module to load the format class from.
1782
        :param member_name: Attribute name within the module for the format class.
1783
        """
1784
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1785
        self._format_string = format_string
1786
        
1787
    def get_format_string(self):
1788
        """See BranchFormat.get_format_string."""
1789
        return self._format_string
1790
1791
    def __call__(self):
1792
        """Used for network_format_registry support."""
1793
        return self.get_obj()()
1794
1795
2370.4.1 by Robert Collins
New SmartServer hooks facility. There are two initial hooks documented
1796
class BranchHooks(Hooks):
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1797
    """A dictionary mapping hook name to a list of callables for branch hooks.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1798
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1799
    e.g. ['set_rh'] Is the list of items to be called when the
1800
    set_revision_history function is invoked.
1801
    """
1802
5622.3.10 by Jelmer Vernooij
Don't require arguments to hooks.
1803
    def __init__(self):
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1804
        """Create the default hooks.
1805
1806
        These are all empty initially, because by default nothing should get
1807
        notified.
1808
        """
5622.3.10 by Jelmer Vernooij
Don't require arguments to hooks.
1809
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1810
        self.add_hook('set_rh',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1811
            "Invoked whenever the revision history has been set via "
1812
            "set_revision_history. The api signature is (branch, "
1813
            "revision_history), and the branch will be write-locked. "
1814
            "The set_rh hook can be expensive for bzr to trigger, a better "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1815
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1816
        self.add_hook('open',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1817
            "Called with the Branch object that has been opened after a "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1818
            "branch is opened.", (1, 8))
1819
        self.add_hook('post_push',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1820
            "Called after a push operation completes. post_push is called "
4053.3.4 by Jelmer Vernooij
Update branch hooks documentation.
1821
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1822
            "bzr client.", (0, 15))
1823
        self.add_hook('post_pull',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1824
            "Called after a pull operation completes. post_pull is called "
1825
            "with a bzrlib.branch.PullResult object and only runs in the "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1826
            "bzr client.", (0, 15))
1827
        self.add_hook('pre_commit',
5430.4.2 by Vincent Ladeuil
Fix typo in Branch.pre_commit HookPoint docstring.
1828
            "Called after a commit is calculated but before it is "
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1829
            "completed. pre_commit is called with (local, master, old_revno, "
1830
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1831
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1832
            "tree_delta is a TreeDelta object describing changes from the "
1833
            "basis revision. hooks MUST NOT modify this delta. "
1834
            " future_tree is an in-memory tree obtained from "
1835
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1836
            "tree.", (0,91))
1837
        self.add_hook('post_commit',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1838
            "Called in the bzr client after a commit has completed. "
1839
            "post_commit is called with (local, master, old_revno, old_revid, "
1840
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1841
            "commit to a branch.", (0, 15))
1842
        self.add_hook('post_uncommit',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1843
            "Called in the bzr client after an uncommit completes. "
1844
            "post_uncommit is called with (local, master, old_revno, "
1845
            "old_revid, new_revno, new_revid) where local is the local branch "
1846
            "or None, master is the target branch, and an empty branch "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1847
            "receives new_revno of 0, new_revid of None.", (0, 15))
1848
        self.add_hook('pre_change_branch_tip',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1849
            "Called in bzr client and server before a change to the tip of a "
1850
            "branch is made. pre_change_branch_tip is called with a "
1851
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1852
            "commit, uncommit will all trigger this hook.", (1, 6))
1853
        self.add_hook('post_change_branch_tip',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1854
            "Called in bzr client and server after a change to the tip of a "
1855
            "branch is made. post_change_branch_tip is called with a "
1856
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1857
            "commit, uncommit will all trigger this hook.", (1, 4))
1858
        self.add_hook('transform_fallback_location',
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1859
            "Called when a stacked branch is activating its fallback "
1860
            "locations. transform_fallback_location is called with (branch, "
1861
            "url), and should return a new url. Returning the same url "
1862
            "allows it to be used as-is, returning a different one can be "
1863
            "used to cause the branch to stack on a closer copy of that "
1864
            "fallback_location. Note that the branch cannot have history "
1865
            "accessing methods called on it during this hook because the "
1866
            "fallback locations have not been activated. When there are "
1867
            "multiple hooks installed for transform_fallback_location, "
1868
            "all are called with the url returned from the previous hook."
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1869
            "The order is however undefined.", (1, 9))
1870
        self.add_hook('automatic_tag_name',
5050.20.1 by Alexander Belchenko
trivial doc change to provide better docs in html format (space between two sentences needed)
1871
            "Called to determine an automatic tag name for a revision. "
5086.4.5 by Jelmer Vernooij
Make automatic_tag_name a hook on Branch.
1872
            "automatic_tag_name is called with (branch, revision_id) and "
1873
            "should return a tag name or None if no tag name could be "
5086.4.9 by Jelmer Vernooij
Update documentation.
1874
            "determined. The first non-None tag name returned will be used.",
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1875
            (2, 2))
1876
        self.add_hook('post_branch_init',
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1877
            "Called after new branch initialization completes. "
5107.3.6 by Marco Pantaleoni
Documented behaviour of 'post_branch_init' for lightweight checkouts.
1878
            "post_branch_init is called with a "
1879
            "bzrlib.branch.BranchInitHookParams. "
1880
            "Note that init, branch and checkout (both heavyweight and "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1881
            "lightweight) will all trigger this hook.", (2, 2))
1882
        self.add_hook('post_switch',
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1883
            "Called after a checkout switches branch. "
1884
            "post_switch is called with a "
5622.3.2 by Jelmer Vernooij
Add more lazily usable hook points.
1885
            "bzrlib.branch.SwitchHookParams.", (2, 2))
5086.4.5 by Jelmer Vernooij
Make automatic_tag_name a hook on Branch.
1886
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1887
1888
1889
# install the default hooks into the Branch class.
5622.3.10 by Jelmer Vernooij
Don't require arguments to hooks.
1890
Branch.hooks = BranchHooks()
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1891
1892
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1893
class ChangeBranchTipParams(object):
5891.1.2 by Andrew Bennetts
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.
1894
    """Object holding parameters passed to `*_change_branch_tip` hooks.
3331.1.5 by James Henstridge
Put revno before revid in method arguments to match last_revision_info()
1895
3331.1.7 by James Henstridge
Make the branch a member of the ChangeBranchTipParams object.
1896
    There are 5 fields that hooks may wish to access:
3331.1.5 by James Henstridge
Put revno before revid in method arguments to match last_revision_info()
1897
3331.1.13 by James Henstridge
Use last_revision_info() to retrieve the new revision number and ID.
1898
    :ivar branch: the branch being changed
1899
    :ivar old_revno: revision number before the change
1900
    :ivar new_revno: revision number after the change
1901
    :ivar old_revid: revision id before the change
1902
    :ivar new_revid: revision id after the change
3331.1.5 by James Henstridge
Put revno before revid in method arguments to match last_revision_info()
1903
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1904
    The revid fields are strings. The revno fields are integers.
1905
    """
1906
3331.1.7 by James Henstridge
Make the branch a member of the ChangeBranchTipParams object.
1907
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1908
        """Create a group of ChangeBranchTip parameters.
1909
3331.1.7 by James Henstridge
Make the branch a member of the ChangeBranchTipParams object.
1910
        :param branch: The branch being changed.
3331.1.5 by James Henstridge
Put revno before revid in method arguments to match last_revision_info()
1911
        :param old_revno: Revision number before the change.
1912
        :param new_revno: Revision number after the change.
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1913
        :param old_revid: Tip revision id before the change.
1914
        :param new_revid: Tip revision id after the change.
1915
        """
3331.1.7 by James Henstridge
Make the branch a member of the ChangeBranchTipParams object.
1916
        self.branch = branch
3331.1.5 by James Henstridge
Put revno before revid in method arguments to match last_revision_info()
1917
        self.old_revno = old_revno
1918
        self.new_revno = new_revno
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1919
        self.old_revid = old_revid
1920
        self.new_revid = new_revid
1921
3517.2.3 by Andrew Bennetts
Better tests for {pre,post}_change_branch_tip hooks.
1922
    def __eq__(self, other):
1923
        return self.__dict__ == other.__dict__
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1924
3517.2.3 by Andrew Bennetts
Better tests for {pre,post}_change_branch_tip hooks.
1925
    def __repr__(self):
1926
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1927
            self.__class__.__name__, self.branch,
3517.2.3 by Andrew Bennetts
Better tests for {pre,post}_change_branch_tip hooks.
1928
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1929
5107.3.4 by Marco Pantaleoni
Applied suggestions from merge reviewer (John A Meinel):
1930
5107.3.2 by Marco Pantaleoni
Renamed 'post_branch' hook to 'post_branch_init', for more consistency,
1931
class BranchInitHookParams(object):
5891.1.2 by Andrew Bennetts
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.
1932
    """Object holding parameters passed to `*_branch_init` hooks.
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1933
1934
    There are 4 fields that hooks may wish to access:
1935
1936
    :ivar format: the branch format
5107.3.6 by Marco Pantaleoni
Documented behaviour of 'post_branch_init' for lightweight checkouts.
1937
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1938
    :ivar name: name of colocated branch, if any (or None)
5107.3.6 by Marco Pantaleoni
Documented behaviour of 'post_branch_init' for lightweight checkouts.
1939
    :ivar branch: the branch created
1940
1941
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1942
    the checkout, hence they are different from the corresponding fields in
1943
    branch, which refer to the original branch.
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1944
    """
1945
1946
    def __init__(self, format, a_bzrdir, name, branch):
5107.3.2 by Marco Pantaleoni
Renamed 'post_branch' hook to 'post_branch_init', for more consistency,
1947
        """Create a group of BranchInitHook parameters.
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1948
1949
        :param format: the branch format
5107.3.6 by Marco Pantaleoni
Documented behaviour of 'post_branch_init' for lightweight checkouts.
1950
        :param a_bzrdir: the BzrDir where the branch will be/has been
1951
            initialized
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1952
        :param name: name of colocated branch, if any (or None)
5107.3.6 by Marco Pantaleoni
Documented behaviour of 'post_branch_init' for lightweight checkouts.
1953
        :param branch: the branch created
1954
1955
        Note that for lightweight checkouts, the bzrdir and format fields refer
1956
        to the checkout, hence they are different from the corresponding fields
1957
        in branch, which refer to the original branch.
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1958
        """
1959
        self.format = format
1960
        self.bzrdir = a_bzrdir
5107.3.4 by Marco Pantaleoni
Applied suggestions from merge reviewer (John A Meinel):
1961
        self.name = name
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1962
        self.branch = branch
1963
1964
    def __eq__(self, other):
1965
        return self.__dict__ == other.__dict__
1966
1967
    def __repr__(self):
5050.21.1 by Andrew Bennetts
Remove broken and apparently unused code path from BranchInitHookParams.__repr__.
1968
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1969
5107.3.4 by Marco Pantaleoni
Applied suggestions from merge reviewer (John A Meinel):
1970
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1971
class SwitchHookParams(object):
5891.1.2 by Andrew Bennetts
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.
1972
    """Object holding parameters passed to `*_switch` hooks.
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1973
1974
    There are 4 fields that hooks may wish to access:
1975
1976
    :ivar control_dir: BzrDir of the checkout to change
1977
    :ivar to_branch: branch that the checkout is to reference
1978
    :ivar force: skip the check for local commits in a heavy checkout
1979
    :ivar revision_id: revision ID to switch to (or None)
1980
    """
1981
1982
    def __init__(self, control_dir, to_branch, force, revision_id):
1983
        """Create a group of SwitchHook parameters.
1984
1985
        :param control_dir: BzrDir of the checkout to change
1986
        :param to_branch: branch that the checkout is to reference
1987
        :param force: skip the check for local commits in a heavy checkout
1988
        :param revision_id: revision ID to switch to (or None)
1989
        """
1990
        self.control_dir = control_dir
5107.3.4 by Marco Pantaleoni
Applied suggestions from merge reviewer (John A Meinel):
1991
        self.to_branch = to_branch
1992
        self.force = force
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
1993
        self.revision_id = revision_id
1994
1995
    def __eq__(self, other):
1996
        return self.__dict__ == other.__dict__
1997
1998
    def __repr__(self):
1999
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2000
            self.control_dir, self.to_branch,
2001
            self.revision_id)
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
2002
5107.3.4 by Marco Pantaleoni
Applied suggestions from merge reviewer (John A Meinel):
2003
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2004
class BranchFormatMetadir(BranchFormat):
2005
    """Common logic for meta-dir based branch formats."""
2006
2007
    def _branch_class(self):
2008
        """What class to instantiate on open calls."""
2009
        raise NotImplementedError(self._branch_class)
2010
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2011
    def _get_initial_config(self, append_revisions_only=None):
2012
        if append_revisions_only:
2013
            return "append_revisions_only = True\n"
2014
        else:
2015
            # Avoid writing anything if append_revisions_only is disabled,
2016
            # as that is the default.
2017
            return ""
2018
5757.1.2 by Jelmer Vernooij
Add separate file for knit pack repository formats.
2019
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2020
                           repository=None):
2021
        """Initialize a branch in a bzrdir, with specified files
2022
2023
        :param a_bzrdir: The bzrdir to initialize the branch in
2024
        :param utf8_files: The files to create as a list of
2025
            (filename, content) tuples
2026
        :param name: Name of colocated branch to create, if any
2027
        :return: a branch in this format
2028
        """
2029
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2030
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2031
        control_files = lockable_files.LockableFiles(branch_transport,
2032
            'lock', lockdir.LockDir)
2033
        control_files.create_lock()
2034
        control_files.lock_write()
2035
        try:
2036
            utf8_files += [('format', self.get_format_string())]
2037
            for (filename, content) in utf8_files:
2038
                branch_transport.put_bytes(
2039
                    filename, content,
2040
                    mode=a_bzrdir._get_file_mode())
2041
        finally:
2042
            control_files.unlock()
2043
        branch = self.open(a_bzrdir, name, _found=True,
2044
                found_repository=repository)
2045
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2046
        return branch
2047
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
2048
    def network_name(self):
2049
        """A simple byte string uniquely identifying this format for RPC calls.
2050
2051
        Metadir branch formats use their format string.
2052
        """
2053
        return self.get_format_string()
2054
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2055
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2056
            found_repository=None):
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
2057
        """See BranchFormat.open()."""
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2058
        if not _found:
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
2059
            format = BranchFormat.find_format(a_bzrdir, name=name)
3221.13.3 by Ian Clatworthy
Merge bzr.dev r3466
2060
            if format.__class__ != self.__class__:
2061
                raise AssertionError("wrong format %r found for %r" %
2062
                    (format, self))
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
2063
        transport = a_bzrdir.get_branch_transport(None, name=name)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2064
        try:
2065
            control_files = lockable_files.LockableFiles(transport, 'lock',
2066
                                                         lockdir.LockDir)
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2067
            if found_repository is None:
2068
                found_repository = a_bzrdir.find_repository()
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2069
            return self._branch_class()(_format=self,
2070
                              _control_files=control_files,
5085.1.1 by Jelmer Vernooij
Let branches know about their colocated name.
2071
                              name=name,
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2072
                              a_bzrdir=a_bzrdir,
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2073
                              _repository=found_repository,
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
2074
                              ignore_fallbacks=ignore_fallbacks)
3221.13.3 by Ian Clatworthy
Merge bzr.dev r3466
2075
        except errors.NoSuchFile:
4734.4.7 by Andrew Bennetts
Defer checking for a repository in NotBranchError case until we format the error as a string. (test_smart currently fails)
2076
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2077
2078
    def __init__(self):
2079
        super(BranchFormatMetadir, self).__init__()
2080
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3834.5.2 by John Arbash Meinel
Track down the various BranchFormats that weren't setting the branch format as part of the _matchingbzrdir format.
2081
        self._matchingbzrdir.set_branch_format(self)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2082
2083
    def supports_tags(self):
2084
        return True
2085
5674.1.1 by Jelmer Vernooij
Add supports_leave_lock flag to BranchFormat and RepositoryFormat.
2086
    def supports_leaving_lock(self):
2087
        return True
2088
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2089
2090
class BzrBranchFormat5(BranchFormatMetadir):
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2091
    """Bzr branch format 5.
2092
2093
    This format has:
2094
     - a revision-history file.
2095
     - a format string
1553.5.71 by Martin Pool
Change branch format 5 to use LockDirs, not transport locks
2096
     - a lock dir guarding the branch itself
2097
     - all of this stored in a branch/ subdirectory
1534.6.4 by Robert Collins
Creating or opening a branch will use the repository if the format supports that.
2098
     - works with shared repositories.
1553.5.71 by Martin Pool
Change branch format 5 to use LockDirs, not transport locks
2099
2100
    This format is new in bzr 0.8.
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2101
    """
2102
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2103
    def _branch_class(self):
2104
        return BzrBranch5
2105
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2106
    def get_format_string(self):
2107
        """See BranchFormat.get_format_string()."""
2108
        return "Bazaar-NG branch format 5\n"
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2109
2110
    def get_format_description(self):
2111
        """See BranchFormat.get_format_description()."""
2112
        return "Branch format 5"
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2113
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2114
    def initialize(self, a_bzrdir, name=None, repository=None,
2115
                   append_revisions_only=None):
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2116
        """Create a branch of this format in a_bzrdir."""
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2117
        if append_revisions_only:
2118
            raise errors.UpgradeRequired(a_bzrdir.user_url)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2119
        utf8_files = [('revision-history', ''),
2120
                      ('branch-name', ''),
2121
                      ]
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2122
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2123
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2124
    def supports_tags(self):
2125
        return False
2126
2127
2128
class BzrBranchFormat6(BranchFormatMetadir):
2696.3.1 by Martin Pool
(broken) start switching format to dirstate-tags
2129
    """Branch format with last-revision and tags.
2230.3.12 by Aaron Bentley
Clean up trailing whitespace
2130
2230.3.38 by Aaron Bentley
Update docs per Martin's suggestion
2131
    Unlike previous formats, this has no explicit revision history. Instead,
2132
    this just stores the last-revision, and the left-hand history leading
2133
    up to there is the history.
2134
2135
    This format was introduced in bzr 0.15
2696.3.1 by Martin Pool
(broken) start switching format to dirstate-tags
2136
    and became the default in 0.91.
2230.3.1 by Aaron Bentley
Get branch6 creation working
2137
    """
2138
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2139
    def _branch_class(self):
2140
        return BzrBranch6
2141
2230.3.1 by Aaron Bentley
Get branch6 creation working
2142
    def get_format_string(self):
2143
        """See BranchFormat.get_format_string()."""
2255.2.230 by Robert Collins
Update tree format signatures to mention introducing bzr version.
2144
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2230.3.1 by Aaron Bentley
Get branch6 creation working
2145
2146
    def get_format_description(self):
2147
        """See BranchFormat.get_format_description()."""
2148
        return "Branch format 6"
2149
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2150
    def initialize(self, a_bzrdir, name=None, repository=None,
2151
                   append_revisions_only=None):
2230.3.1 by Aaron Bentley
Get branch6 creation working
2152
        """Create a branch of this format in a_bzrdir."""
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2153
        utf8_files = [('last-revision', '0 null:\n'),
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2154
                      ('branch.conf',
2155
                          self._get_initial_config(append_revisions_only)),
2220.2.28 by Martin Pool
Integrate tags with Branch6:
2156
                      ('tags', ''),
2230.3.1 by Aaron Bentley
Get branch6 creation working
2157
                      ]
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2158
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2230.3.1 by Aaron Bentley
Get branch6 creation working
2159
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
2160
    def make_tags(self, branch):
2161
        """See bzrlib.branch.BranchFormat.make_tags()."""
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
2162
        return _mod_tag.BasicTags(branch)
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
2163
4301.3.3 by Andrew Bennetts
Move check onto base Branch class, and add a supports_set_append_revisions_only method to BranchFormat, as suggested by Robert.
2164
    def supports_set_append_revisions_only(self):
2165
        return True
4084.2.1 by Robert Collins
Make accessing a branch.tags.get_tag_dict use a smart[er] method rather than VFS calls and real objects.
2166
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2167
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2168
class BzrBranchFormat8(BranchFormatMetadir):
2169
    """Metadir format supporting storing locations of subtree branches."""
2170
2171
    def _branch_class(self):
2172
        return BzrBranch8
2173
2174
    def get_format_string(self):
2175
        """See BranchFormat.get_format_string()."""
2176
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2177
2178
    def get_format_description(self):
2179
        """See BranchFormat.get_format_description()."""
2180
        return "Branch format 8"
2181
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2182
    def initialize(self, a_bzrdir, name=None, repository=None,
2183
                   append_revisions_only=None):
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2184
        """Create a branch of this format in a_bzrdir."""
2185
        utf8_files = [('last-revision', '0 null:\n'),
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2186
                      ('branch.conf',
2187
                          self._get_initial_config(append_revisions_only)),
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2188
                      ('tags', ''),
2189
                      ('references', '')
2190
                      ]
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2191
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2192
2193
    def make_tags(self, branch):
2194
        """See bzrlib.branch.BranchFormat.make_tags()."""
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
2195
        return _mod_tag.BasicTags(branch)
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2196
4301.3.3 by Andrew Bennetts
Move check onto base Branch class, and add a supports_set_append_revisions_only method to BranchFormat, as suggested by Robert.
2197
    def supports_set_append_revisions_only(self):
2198
        return True
2199
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2200
    def supports_stacking(self):
2201
        return True
2202
4273.1.5 by Aaron Bentley
Ensure references are propagated by sprout/clone.
2203
    supports_reference_locations = True
2204
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2205
5757.1.2 by Jelmer Vernooij
Add separate file for knit pack repository formats.
2206
class BzrBranchFormat7(BranchFormatMetadir):
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2207
    """Branch format with last-revision, tags, and a stacked location pointer.
2208
2209
    The stacked location pointer is passed down to the repository and requires
2210
    a repository format with supports_external_lookups = True.
2211
3221.13.6 by Ian Clatworthy
update BzrBranch7 format to say 1.6, not 1.3
2212
    This format was introduced in bzr 1.6.
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2213
    """
2214
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2215
    def initialize(self, a_bzrdir, name=None, repository=None,
2216
                   append_revisions_only=None):
4273.1.12 by Aaron Bentley
Don't create reference files for older formats.
2217
        """Create a branch of this format in a_bzrdir."""
2218
        utf8_files = [('last-revision', '0 null:\n'),
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2219
                      ('branch.conf',
2220
                          self._get_initial_config(append_revisions_only)),
4273.1.12 by Aaron Bentley
Don't create reference files for older formats.
2221
                      ('tags', ''),
2222
                      ]
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2223
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
4273.1.12 by Aaron Bentley
Don't create reference files for older formats.
2224
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2225
    def _branch_class(self):
2226
        return BzrBranch7
2227
2228
    def get_format_string(self):
2229
        """See BranchFormat.get_format_string()."""
3221.13.6 by Ian Clatworthy
update BzrBranch7 format to say 1.6, not 1.3
2230
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2231
2232
    def get_format_description(self):
2233
        """See BranchFormat.get_format_description()."""
2234
        return "Branch format 7"
2235
4301.3.3 by Andrew Bennetts
Move check onto base Branch class, and add a supports_set_append_revisions_only method to BranchFormat, as suggested by Robert.
2236
    def supports_set_append_revisions_only(self):
2237
        return True
2238
5757.1.2 by Jelmer Vernooij
Add separate file for knit pack repository formats.
2239
    def supports_stacking(self):
2240
        return True
2241
5757.1.4 by Jelmer Vernooij
Add bzrlib.repofmt.knitpack_repo to the blacklist in test_import_tariff.
2242
    def make_tags(self, branch):
2243
        """See bzrlib.branch.BranchFormat.make_tags()."""
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
2244
        return _mod_tag.BasicTags(branch)
5757.1.4 by Jelmer Vernooij
Add bzrlib.repofmt.knitpack_repo to the blacklist in test_import_tariff.
2245
4273.1.5 by Aaron Bentley
Ensure references are propagated by sprout/clone.
2246
    supports_reference_locations = False
2247
2230.3.1 by Aaron Bentley
Get branch6 creation working
2248
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2249
class BranchReferenceFormat(BranchFormat):
2250
    """Bzr branch reference format.
2251
2252
    Branch references are used in implementing checkouts, they
2253
    act as an alias to the real branch which is at some other url.
2254
2255
    This format has:
2256
     - A location file
2257
     - a format string
2258
    """
2259
2260
    def get_format_string(self):
2261
        """See BranchFormat.get_format_string()."""
2262
        return "Bazaar-NG Branch Reference Format 1\n"
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2263
2264
    def get_format_description(self):
2265
        """See BranchFormat.get_format_description()."""
2266
        return "Checkout reference format 1"
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
2267
5147.4.6 by Jelmer Vernooij
consistency in names
2268
    def get_reference(self, a_bzrdir, name=None):
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
2269
        """See BranchFormat.get_reference()."""
5147.4.6 by Jelmer Vernooij
consistency in names
2270
        transport = a_bzrdir.get_branch_transport(None, name=name)
4708.2.1 by Martin
Ensure all files opened by bazaar proper are explicitly closed
2271
        return transport.get_bytes('location')
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
2272
5147.4.6 by Jelmer Vernooij
consistency in names
2273
    def set_reference(self, a_bzrdir, name, to_branch):
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
2274
        """See BranchFormat.set_reference()."""
5147.4.6 by Jelmer Vernooij
consistency in names
2275
        transport = a_bzrdir.get_branch_transport(None, name=name)
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
2276
        location = transport.put_bytes('location', to_branch.base)
2277
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2278
    def initialize(self, a_bzrdir, name=None, target_branch=None,
6123.9.12 by Jelmer Vernooij
Add append_revisions_only argument to BranchFormat.initialize.
2279
            repository=None, append_revisions_only=None):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2280
        """Create a branch of this format in a_bzrdir."""
2281
        if target_branch is None:
2282
            # this format does not implement branch itself, thus the implicit
2283
            # creation contract must see it as uninitializable
2284
            raise errors.UninitializableFormat(self)
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
2285
        mutter('creating branch reference in %s', a_bzrdir.user_url)
6082.1.1 by Jelmer Vernooij
Don't attempt to create branch references in control directories that don't support it.
2286
        if a_bzrdir._format.fixed_components:
2287
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
2288
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1955.3.9 by John Arbash Meinel
Find more occurrances of put() and replace with put_file or put_bytes
2289
        branch_transport.put_bytes('location',
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
2290
            target_branch.bzrdir.user_url)
1955.3.9 by John Arbash Meinel
Find more occurrances of put() and replace with put_file or put_bytes
2291
        branch_transport.put_bytes('format', self.get_format_string())
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
2292
        branch = self.open(
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
2293
            a_bzrdir, name, _found=True,
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
2294
            possible_transports=[target_branch.bzrdir.root_transport])
5107.3.4 by Marco Pantaleoni
Applied suggestions from merge reviewer (John A Meinel):
2295
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
5107.3.1 by Marco Pantaleoni
Added the new hooks 'post_branch', 'post_switch' and 'post_repo_init',
2296
        return branch
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2297
2298
    def __init__(self):
2299
        super(BranchReferenceFormat, self).__init__()
2300
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3834.5.2 by John Arbash Meinel
Track down the various BranchFormats that weren't setting the branch format as part of the _matchingbzrdir format.
2301
        self._matchingbzrdir.set_branch_format(self)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2302
2303
    def _make_reference_clone_function(format, a_branch):
2304
        """Create a clone() routine for a branch dynamically."""
4050.1.3 by Robert Collins
Add missed new parameter for branch reference cloning.
2305
        def clone(to_bzrdir, revision_id=None,
2306
            repository_policy=None):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2307
            """See Branch.clone()."""
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
2308
            return format.initialize(to_bzrdir, target_branch=a_branch)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2309
            # cannot obey revision_id limits when cloning a reference ...
2310
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2311
            # emit some sort of warning/error to the caller ?!
2312
        return clone
2313
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
2314
    def open(self, a_bzrdir, name=None, _found=False, location=None,
5536.1.1 by Andrew Bennetts
Avoid reopening (and relocking) the same branches/repositories in ControlDir.sprout. Still a few rough edges, but the tests I've run are passing.
2315
             possible_transports=None, ignore_fallbacks=False,
2316
             found_repository=None):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2317
        """Return the branch that the branch reference in a_bzrdir points at.
2318
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
2319
        :param a_bzrdir: A BzrDir that contains a branch.
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
2320
        :param name: Name of colocated branch to open, if any
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
2321
        :param _found: a private parameter, do not use it. It is used to
2322
            indicate if format probing has already be done.
2323
        :param ignore_fallbacks: when set, no fallback branches will be opened
2324
            (if there are any).  Default is to open fallbacks.
2325
        :param location: The location of the referenced branch.  If
2326
            unspecified, this will be determined from the branch reference in
2327
            a_bzrdir.
2328
        :param possible_transports: An optional reusable transports list.
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2329
        """
2330
        if not _found:
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
2331
            format = BranchFormat.find_format(a_bzrdir, name=name)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
2332
            if format.__class__ != self.__class__:
2333
                raise AssertionError("wrong format %r found for %r" %
2334
                    (format, self))
2018.6.1 by Robert Collins
Implement a BzrDir.open_branch smart server method for opening a branch without VFS.
2335
        if location is None:
5147.4.4 by Jelmer Vernooij
Support colocated branches in BranchReference.
2336
            location = self.get_reference(a_bzrdir, name)
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
2337
        real_bzrdir = bzrdir.BzrDir.open(
2338
            location, possible_transports=possible_transports)
5051.3.10 by Jelmer Vernooij
Pass colocated branch name around in more places.
2339
        result = real_bzrdir.open_branch(name=name, 
2340
            ignore_fallbacks=ignore_fallbacks)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2341
        # this changes the behaviour of result.clone to create a new reference
2342
        # rather than a copy of the content of the branch.
2343
        # I did not use a proxy object because that needs much more extensive
2344
        # testing, and we are only changing one behaviour at the moment.
2345
        # If we decide to alter more behaviours - i.e. the implicit nickname
2346
        # then this should be refactored to introduce a tested proxy branch
2347
        # and a subclass of that for use in overriding clone() and ....
2348
        # - RBC 20060210
2349
        result.clone = self._make_reference_clone_function(result)
2350
        return result
2351
2352
5669.3.9 by Jelmer Vernooij
Consistent naming.
2353
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
5662.2.1 by Jelmer Vernooij
Add BranchFormatRegistry.
2354
    """Branch format registry."""
2355
2356
    def __init__(self, other_registry=None):
2357
        super(BranchFormatRegistry, self).__init__(other_registry)
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
2358
        self._default_format = None
2359
2360
    def set_default(self, format):
2361
        self._default_format = format
2362
2363
    def get_default(self):
2364
        return self._default_format
2365
5662.2.1 by Jelmer Vernooij
Add BranchFormatRegistry.
2366
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
2367
network_format_registry = registry.FormatRegistry()
2368
"""Registry of formats indexed by their network name.
2369
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2370
The network name for a branch format is an identifier that can be used when
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
2371
referring to formats with smart server operations. See
2372
BranchFormat.network_name() for more detail.
2373
"""
2374
5662.2.1 by Jelmer Vernooij
Add BranchFormatRegistry.
2375
format_registry = BranchFormatRegistry(network_format_registry)
2376
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
2377
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
2378
# formats which have no format string are not discoverable
2379
# and not independently creatable, so are not registered.
2696.3.3 by Martin Pool
Start setting the default format to dirstate-tags
2380
__format5 = BzrBranchFormat5()
2381
__format6 = BzrBranchFormat6()
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2382
__format7 = BzrBranchFormat7()
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2383
__format8 = BzrBranchFormat8()
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
2384
format_registry.register(__format5)
2385
format_registry.register(BranchReferenceFormat())
2386
format_registry.register(__format6)
2387
format_registry.register(__format7)
2388
format_registry.register(__format8)
2389
format_registry.set_default(__format7)
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
2390
1534.4.5 by Robert Collins
Turn branch format.open into a factory.
2391
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
2392
class BranchWriteLockResult(LogicalLockResult):
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
2393
    """The result of write locking a branch.
2394
2395
    :ivar branch_token: The token obtained from the underlying branch lock, or
2396
        None.
2397
    :ivar unlock: A callable which will unlock the lock.
2398
    """
2399
2400
    def __init__(self, unlock, branch_token):
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
2401
        LogicalLockResult.__init__(self, unlock)
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
2402
        self.branch_token = branch_token
2403
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
2404
    def __repr__(self):
5200.3.5 by Robert Collins
Add __str__ to the new helper classes.
2405
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2406
            self.unlock)
2407
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
2408
4731.1.2 by Andrew Bennetts
Refactor to reduce duplication.
2409
class BzrBranch(Branch, _RelockDebugMixin):
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
2410
    """A branch stored in the actual filesystem.
2411
2412
    Note that it's "local" in the context of the filesystem; it doesn't
2413
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
2414
    it's writable, and can be accessed via the normal filesystem API.
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
2415
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2416
    :ivar _transport: Transport for file operations on this branch's
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
2417
        control files, typically pointing to the .bzr/branch directory.
2418
    :ivar repository: Repository for this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2419
    :ivar base: The url of the base directory for this branch; the one
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
2420
        containing the .bzr directory.
5085.1.1 by Jelmer Vernooij
Let branches know about their colocated name.
2421
    :ivar name: Optional colocated branch name as it exists in the control
2422
        directory.
1 by mbp at sourcefrog
import from baz patch-364
2423
    """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2424
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
2425
    def __init__(self, _format=None,
5085.1.1 by Jelmer Vernooij
Let branches know about their colocated name.
2426
                 _control_files=None, a_bzrdir=None, name=None,
2427
                 _repository=None, ignore_fallbacks=False):
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
2428
        """Create new branch object at a particular location."""
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2429
        if a_bzrdir is None:
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
2430
            raise ValueError('a_bzrdir must be supplied')
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2431
        else:
2432
            self.bzrdir = a_bzrdir
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
2433
        self._base = self.bzrdir.transport.clone('..').base
5085.1.1 by Jelmer Vernooij
Let branches know about their colocated name.
2434
        self.name = name
3446.1.1 by Martin Pool
merge further LockableFile deprecations
2435
        # XXX: We should be able to just do
2436
        #   self.base = self.bzrdir.root_transport.base
2437
        # but this does not quite work yet -- mbp 20080522
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
2438
        self._format = _format
1534.4.28 by Robert Collins
first cut at merge from integration.
2439
        if _control_files is None:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
2440
            raise ValueError('BzrBranch _control_files is None')
1534.4.28 by Robert Collins
first cut at merge from integration.
2441
        self.control_files = _control_files
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
2442
        self._transport = _control_files._transport
1534.6.4 by Robert Collins
Creating or opening a branch will use the repository if the format supports that.
2443
        self.repository = _repository
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2444
        Branch.__init__(self)
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
2445
1 by mbp at sourcefrog
import from baz patch-364
2446
    def __str__(self):
5085.1.1 by Jelmer Vernooij
Let branches know about their colocated name.
2447
        if self.name is None:
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
2448
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
5085.1.1 by Jelmer Vernooij
Let branches know about their colocated name.
2449
        else:
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
2450
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2451
                self.name)
1 by mbp at sourcefrog
import from baz patch-364
2452
2453
    __repr__ = __str__
2454
907.1.17 by John Arbash Meinel
Adding a Branch.base property, removing pull_loc()
2455
    def _get_base(self):
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
2456
        """Returns the directory containing the control directory."""
1185.69.2 by John Arbash Meinel
Changed LockableFiles to take the root directory directly. Moved mode information into LockableFiles instead of Branch
2457
        return self._base
907.1.17 by John Arbash Meinel
Adding a Branch.base property, removing pull_loc()
2458
1442.1.5 by Robert Collins
Give branch.base a docstring.
2459
    base = property(_get_base, doc="The URL for the root of this branch.")
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
2460
4226.1.5 by Robert Collins
Reinstate the use of the Branch.get_config_file verb.
2461
    def _get_config(self):
6105.1.1 by Jelmer Vernooij
Fix "pydoc bzrlib.branch" by importing modules, not objects, using lazy_import.
2462
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
4226.1.5 by Robert Collins
Reinstate the use of the Branch.get_config_file verb.
2463
1694.2.6 by Martin Pool
[merge] bzr.dev
2464
    def is_locked(self):
2465
        return self.control_files.is_locked()
2466
2018.5.142 by Andrew Bennetts
Change Branch.lock_token to only accept and receive the branch lock token (rather than the branch and repo lock tokens).
2467
    def lock_write(self, token=None):
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
2468
        """Lock the branch for write operations.
2469
2470
        :param token: A token to permit reacquiring a previously held and
2471
            preserved lock.
2472
        :return: A BranchWriteLockResult.
2473
        """
4731.1.2 by Andrew Bennetts
Refactor to reduce duplication.
2474
        if not self.is_locked():
2475
            self._note_lock('w')
4288.1.12 by Robert Collins
Review feedback.
2476
        # All-in-one needs to always unlock/lock.
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
2477
        repo_control = getattr(self.repository, 'control_files', None)
4288.1.11 by Robert Collins
Hopefully fix locking tests to match the new code (and still be good statements of intent).
2478
        if self.control_files == repo_control or not self.is_locked():
4840.2.7 by Vincent Ladeuil
Move the _warn_if_deprecated call from repo.__init__ to
2479
            self.repository._warn_if_deprecated(self)
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
2480
            self.repository.lock_write()
2481
            took_lock = True
2482
        else:
2483
            took_lock = False
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
2484
        try:
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
2485
            return BranchWriteLockResult(self.unlock,
2486
                self.control_files.lock_write(token=token))
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
2487
        except:
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
2488
            if took_lock:
2489
                self.repository.unlock()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
2490
            raise
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
2491
1185.65.3 by Aaron Bentley
Fixed locking-- all tests pass
2492
    def lock_read(self):
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
2493
        """Lock the branch for read operations.
2494
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
2495
        :return: A bzrlib.lock.LogicalLockResult.
5200.3.3 by Robert Collins
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
2496
        """
4731.1.2 by Andrew Bennetts
Refactor to reduce duplication.
2497
        if not self.is_locked():
2498
            self._note_lock('r')
4288.1.12 by Robert Collins
Review feedback.
2499
        # All-in-one needs to always unlock/lock.
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
2500
        repo_control = getattr(self.repository, 'control_files', None)
4288.1.11 by Robert Collins
Hopefully fix locking tests to match the new code (and still be good statements of intent).
2501
        if self.control_files == repo_control or not self.is_locked():
4840.2.7 by Vincent Ladeuil
Move the _warn_if_deprecated call from repo.__init__ to
2502
            self.repository._warn_if_deprecated(self)
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
2503
            self.repository.lock_read()
2504
            took_lock = True
2505
        else:
2506
            took_lock = False
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
2507
        try:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
2508
            self.control_files.lock_read()
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
2509
            return LogicalLockResult(self.unlock)
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
2510
        except:
4288.1.10 by Robert Collins
Fix up lock correctness to deal with adding fallback repositories to locked branch objects.
2511
            if took_lock:
2512
                self.repository.unlock()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
2513
            raise
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
2514
4634.85.11 by Andrew Bennetts
Suppress most errors from Branch.unlock too.
2515
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
2516
    def unlock(self):
4288.1.11 by Robert Collins
Hopefully fix locking tests to match the new code (and still be good statements of intent).
2517
        try:
2518
            self.control_files.unlock()
2519
        finally:
4288.1.12 by Robert Collins
Review feedback.
2520
            # All-in-one needs to always unlock/lock.
4288.1.11 by Robert Collins
Hopefully fix locking tests to match the new code (and still be good statements of intent).
2521
            repo_control = getattr(self.repository, 'control_files', None)
2522
            if (self.control_files == repo_control or
2523
                not self.control_files.is_locked()):
2524
                self.repository.unlock()
2525
            if not self.control_files.is_locked():
2526
                # we just released the lock
2527
                self._clear_cached_state()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2528
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
2529
    def peek_lock_mode(self):
2530
        if self.control_files._lock_count == 0:
2531
            return None
2532
        else:
2533
            return self.control_files._lock_mode
2534
1694.2.6 by Martin Pool
[merge] bzr.dev
2535
    def get_physical_lock_status(self):
2536
        return self.control_files.get_physical_lock_status()
2537
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
2538
    @needs_read_lock
1185.50.9 by John Arbash Meinel
[bug 3632] Matthieu Moy- bzr cat should default to last revision
2539
    def print_file(self, file, revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
2540
        """See Branch.print_file."""
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
2541
        return self.repository.print_file(file, revision_id)
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
2542
5718.7.15 by Jelmer Vernooij
Decorate _set_revision_history rather than set_revision_history.
2543
    @needs_write_lock
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2544
    def set_last_revision_info(self, revno, revision_id):
5718.8.12 by Jelmer Vernooij
Fix raising of InvalidRevisionId.
2545
        if not revision_id or not isinstance(revision_id, basestring):
2546
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
5718.8.3 by Jelmer Vernooij
More branch restructuring.
2547
        revision_id = _mod_revision.ensure_null(revision_id)
2548
        old_revno, old_revid = self.last_revision_info()
6123.9.11 by Jelmer Vernooij
Make get_append_revisions_only public.
2549
        if self.get_append_revisions_only():
5718.8.3 by Jelmer Vernooij
More branch restructuring.
2550
            self._check_history_violation(revision_id)
2551
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2552
        self._write_last_revision_info(revno, revision_id)
2553
        self._clear_cached_state()
2554
        self._last_revision_info_cache = revno, revision_id
2555
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2230.4.1 by Aaron Bentley
Get log as fast branch5
2556
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
2557
    def basis_tree(self):
2558
        """See Branch.basis_tree."""
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
2559
        return self.repository.revision_tree(self.last_revision())
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
2560
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2561
    def _get_parent_location(self):
2562
        _locs = ['parent', 'pull', 'x-pull']
2563
        for l in _locs:
2564
            try:
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
2565
                return self._transport.get_bytes(l).strip('\n')
3236.1.2 by Michael Hudson
clean up branch.py imports
2566
            except errors.NoSuchFile:
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2567
                pass
2568
        return None
2569
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
2570
    def get_stacked_on_url(self):
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
2571
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2572
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
2573
    def set_push_location(self, location):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
2574
        """See Branch.set_push_location."""
2120.6.4 by James Henstridge
add support for specifying policy when storing options
2575
        self.get_config().set_user_option(
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
2576
            'push_location', location,
2577
            store=_mod_config.STORE_LOCATION_NORECURSE)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
2578
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2579
    def _set_parent_location(self, url):
2580
        if url is None:
3407.2.3 by Martin Pool
Branch and Repository use their own ._transport rather than going through .control_files
2581
            self._transport.delete('parent')
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2582
        else:
3407.2.3 by Martin Pool
Branch and Repository use their own ._transport rather than going through .control_files
2583
            self._transport.put_bytes('parent', url + '\n',
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2584
                mode=self.bzrdir._get_file_mode())
1150 by Martin Pool
- add new Branch.set_parent and tests
2585
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
2586
    @needs_write_lock
2587
    def unbind(self):
2588
        """If bound, unbind"""
2589
        return self.set_bound_location(None)
2590
2591
    @needs_write_lock
2592
    def bind(self, other):
2593
        """Bind this branch to the branch other.
2594
2595
        This does not push or pull data between the branches, though it does
2596
        check for divergence to raise an error when the branches are not
2597
        either the same, or one a prefix of the other. That behaviour may not
2598
        be useful, so that check may be removed in future.
2599
2600
        :param other: The branch to bind to
2601
        :type other: Branch
2602
        """
2603
        # TODO: jam 20051230 Consider checking if the target is bound
2604
        #       It is debatable whether you should be able to bind to
2605
        #       a branch which is itself bound.
2606
        #       Committing is obviously forbidden,
2607
        #       but binding itself may not be.
2608
        #       Since we *have* to check at commit time, we don't
2609
        #       *need* to check here
2610
2611
        # we want to raise diverged if:
2612
        # last_rev is not in the other_last_rev history, AND
2613
        # other_last_rev is not in our history, and do it without pulling
2614
        # history around
2615
        self.set_bound_location(other.base)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2616
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2617
    def get_bound_location(self):
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
2618
        try:
3388.2.1 by Martin Pool
Deprecate LockableFiles.get_utf8
2619
            return self._transport.get_bytes('bound')[:-1]
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2620
        except errors.NoSuchFile:
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2621
            return None
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
2622
2623
    @needs_read_lock
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2624
    def get_master_branch(self, possible_transports=None):
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
2625
        """Return the branch we are bound to.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2626
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
2627
        :return: Either a Branch, or None
2628
        """
5609.25.3 by Andrew Bennetts
Alternative fix: cache the result of get_master_branch for the lifetime of the branch lock.
2629
        if self._master_branch_cache is None:
2630
            self._master_branch_cache = self._get_master_branch(
2631
                possible_transports)
2632
        return self._master_branch_cache
2633
2634
    def _get_master_branch(self, possible_transports):
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
2635
        bound_loc = self.get_bound_location()
2636
        if not bound_loc:
2637
            return None
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2638
        try:
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2639
            return Branch.open(bound_loc,
2640
                               possible_transports=possible_transports)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2641
        except (errors.NotBranchError, errors.ConnectionError), e:
2642
            raise errors.BoundBranchConnectionFailure(
2643
                    self, bound_loc, e)
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
2644
1505.1.5 by John Arbash Meinel
Added a test for the unbind command.
2645
    @needs_write_lock
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2646
    def set_bound_location(self, location):
1505.1.27 by John Arbash Meinel
Adding tests against an sftp branch.
2647
        """Set the target where this branch is bound to.
2648
2649
        :param location: URL to the target branch
2650
        """
5609.25.3 by Andrew Bennetts
Alternative fix: cache the result of get_master_branch for the lifetime of the branch lock.
2651
        self._master_branch_cache = None
1505.1.25 by John Arbash Meinel
Updated pull. Now all paths which call set_revision_history maintain the branch invariant. All tests pass.
2652
        if location:
3446.1.1 by Martin Pool
merge further LockableFile deprecations
2653
            self._transport.put_bytes('bound', location+'\n',
2654
                mode=self.bzrdir._get_file_mode())
1185.64.2 by Goffredo Baroncelli
- implemented some suggestion by Robert Collins
2655
        else:
1505.1.25 by John Arbash Meinel
Updated pull. Now all paths which call set_revision_history maintain the branch invariant. All tests pass.
2656
            try:
3407.2.3 by Martin Pool
Branch and Repository use their own ._transport rather than going through .control_files
2657
                self._transport.delete('bound')
3236.1.2 by Michael Hudson
clean up branch.py imports
2658
            except errors.NoSuchFile:
1505.1.25 by John Arbash Meinel
Updated pull. Now all paths which call set_revision_history maintain the branch invariant. All tests pass.
2659
                return False
2660
            return True
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
2661
1587.1.10 by Robert Collins
update updates working tree and branch together.
2662
    @needs_write_lock
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2663
    def update(self, possible_transports=None):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2664
        """Synchronise this branch with the master branch if any.
1587.1.10 by Robert Collins
update updates working tree and branch together.
2665
2666
        :return: None or the last_revision that was pivoted out during the
2667
                 update.
2668
        """
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2669
        master = self.get_master_branch(possible_transports)
1587.1.10 by Robert Collins
update updates working tree and branch together.
2670
        if master is not None:
2653.2.4 by Aaron Bentley
Remove get_ancestry usage from branch
2671
            old_tip = _mod_revision.ensure_null(self.last_revision())
1587.1.10 by Robert Collins
update updates working tree and branch together.
2672
            self.pull(master, overwrite=True)
2653.2.4 by Aaron Bentley
Remove get_ancestry usage from branch
2673
            if self.repository.get_graph().is_ancestor(old_tip,
2674
                _mod_revision.ensure_null(self.last_revision())):
1587.1.10 by Robert Collins
update updates working tree and branch together.
2675
                return None
2676
            return old_tip
2677
        return None
2678
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
2679
    def _read_last_revision_info(self):
2680
        revision_string = self._transport.get_bytes('last-revision')
2681
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2682
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2683
        revno = int(revno)
2684
        return revno, revision_id
2685
2686
    def _write_last_revision_info(self, revno, revision_id):
2687
        """Simply write out the revision id, with no checks.
2688
2689
        Use set_last_revision_info to perform this safely.
2690
2691
        Does not update the revision_history cache.
2692
        """
2693
        revision_id = _mod_revision.ensure_null(revision_id)
2694
        out_string = '%d %s\n' % (revno, revision_id)
2695
        self._transport.put_bytes('last-revision', out_string,
2696
            mode=self.bzrdir._get_file_mode())
2697
2698
2699
class FullHistoryBzrBranch(BzrBranch):
2700
    """Bzr branch which contains the full revision history."""
2701
2702
    @needs_write_lock
2703
    def set_last_revision_info(self, revno, revision_id):
5718.8.12 by Jelmer Vernooij
Fix raising of InvalidRevisionId.
2704
        if not revision_id or not isinstance(revision_id, basestring):
2705
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
2706
        revision_id = _mod_revision.ensure_null(revision_id)
2707
        # this old format stores the full history, but this api doesn't
2708
        # provide it, so we must generate, and might as well check it's
2709
        # correct
2710
        history = self._lefthand_history(revision_id)
2711
        if len(history) != revno:
2712
            raise AssertionError('%d != %d' % (len(history), revno))
2713
        self._set_revision_history(history)
2714
2715
    def _read_last_revision_info(self):
2716
        rh = self.revision_history()
2717
        revno = len(rh)
2718
        if revno:
2719
            return (revno, rh[-1])
2720
        else:
2721
            return (0, _mod_revision.NULL_REVISION)
2722
2723
    @deprecated_method(deprecated_in((2, 4, 0)))
2724
    @needs_write_lock
2725
    def set_revision_history(self, rev_history):
2726
        """See Branch.set_revision_history."""
2727
        self._set_revision_history(rev_history)
2728
2729
    def _set_revision_history(self, rev_history):
2730
        if 'evil' in debug.debug_flags:
2731
            mutter_callsite(3, "set_revision_history scales with history.")
2732
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2733
        for rev_id in rev_history:
2734
            check_not_reserved_id(rev_id)
2735
        if Branch.hooks['post_change_branch_tip']:
2736
            # Don't calculate the last_revision_info() if there are no hooks
2737
            # that will use it.
2738
            old_revno, old_revid = self.last_revision_info()
2739
        if len(rev_history) == 0:
2740
            revid = _mod_revision.NULL_REVISION
2741
        else:
2742
            revid = rev_history[-1]
2743
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2744
        self._write_revision_history(rev_history)
2745
        self._clear_cached_state()
2746
        self._cache_revision_history(rev_history)
2747
        for hook in Branch.hooks['set_rh']:
2748
            hook(self, rev_history)
2749
        if Branch.hooks['post_change_branch_tip']:
2750
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2751
2752
    def _write_revision_history(self, history):
2753
        """Factored out of set_revision_history.
2754
2755
        This performs the actual writing to disk.
2756
        It is intended to be called by set_revision_history."""
2757
        self._transport.put_bytes(
2758
            'revision-history', '\n'.join(history),
2759
            mode=self.bzrdir._get_file_mode())
2760
2761
    def _gen_revision_history(self):
2762
        history = self._transport.get_bytes('revision-history').split('\n')
2763
        if history[-1:] == ['']:
2764
            # There shouldn't be a trailing newline, but just in case.
2765
            history.pop()
2766
        return history
2767
2768
    def _synchronize_history(self, destination, revision_id):
5718.8.11 by Jelmer Vernooij
Fix _synchronize_history check.
2769
        if not isinstance(destination, FullHistoryBzrBranch):
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
2770
            super(BzrBranch, self)._synchronize_history(
2771
                destination, revision_id)
2772
            return
2773
        if revision_id == _mod_revision.NULL_REVISION:
2774
            new_history = []
2775
        else:
2776
            new_history = self.revision_history()
2777
        if revision_id is not None and new_history != []:
2778
            try:
2779
                new_history = new_history[:new_history.index(revision_id) + 1]
2780
            except ValueError:
2781
                rev = self.repository.get_revision(revision_id)
2782
                new_history = rev.get_history(self.repository)[1:]
2783
        destination._set_revision_history(new_history)
2784
5718.8.6 by Jelmer Vernooij
Move generate_revision_history.
2785
    @needs_write_lock
2786
    def generate_revision_history(self, revision_id, last_rev=None,
2787
        other_branch=None):
2788
        """Create a new revision history that will finish with revision_id.
2789
2790
        :param revision_id: the new tip to use.
2791
        :param last_rev: The previous last_revision. If not None, then this
2792
            must be a ancestory of revision_id, or DivergedBranches is raised.
2793
        :param other_branch: The other branch that DivergedBranches should
2794
            raise with respect to.
2795
        """
2796
        self._set_revision_history(self._lefthand_history(revision_id,
2797
            last_rev, other_branch))
2798
5718.8.2 by Jelmer Vernooij
Split out full history branch code.
2799
2800
class BzrBranch5(FullHistoryBzrBranch):
2801
    """A format 5 branch. This supports new features over plain branches.
2802
2803
    It has support for a master_branch which is the data for bound branches.
2804
    """
2805
2806
2807
class BzrBranch8(BzrBranch):
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2808
    """A branch that stores tree-reference locations."""
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2809
2810
    def _open_hook(self):
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
2811
        if self._ignore_fallbacks:
2812
            return
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2813
        try:
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
2814
            url = self.get_stacked_on_url()
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2815
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2816
            errors.UnstackableBranchFormat):
2817
            pass
2818
        else:
3770.2.1 by Michael Hudson
test and feature
2819
            for hook in Branch.hooks['transform_fallback_location']:
2820
                url = hook(self, url)
3770.2.3 by Michael Hudson
check for None being returned for a hook
2821
                if url is None:
2822
                    hook_name = Branch.hooks.get_hook_name(hook)
2823
                    raise AssertionError(
2824
                        "'transform_fallback_location' hook %s returned "
2825
                        "None, not a URL." % hook_name)
4379.2.2 by John Arbash Meinel
Change the Repository.add_fallback_repository() contract slightly.
2826
            self._activate_fallback_location(url)
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2827
4160.2.8 by Andrew Bennetts
Slightly less messy BzrBranch7.__init__.
2828
    def __init__(self, *args, **kwargs):
2829
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2830
        super(BzrBranch8, self).__init__(*args, **kwargs)
3060.3.1 by Lukáš Lalinský
Cache last_revision_info in BzrBranch6, since this is often called multiple times within one lock and we don't want to read the file over and over again.
2831
        self._last_revision_info_cache = None
4273.1.15 by Aaron Bentley
Add reference_info caching.
2832
        self._reference_info = None
3060.3.1 by Lukáš Lalinský
Cache last_revision_info in BzrBranch6, since this is often called multiple times within one lock and we don't want to read the file over and over again.
2833
2834
    def _clear_cached_state(self):
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2835
        super(BzrBranch8, self)._clear_cached_state()
3060.3.1 by Lukáš Lalinský
Cache last_revision_info in BzrBranch6, since this is often called multiple times within one lock and we don't want to read the file over and over again.
2836
        self._last_revision_info_cache = None
4273.1.15 by Aaron Bentley
Add reference_info caching.
2837
        self._reference_info = None
3060.3.1 by Lukáš Lalinský
Cache last_revision_info in BzrBranch6, since this is often called multiple times within one lock and we don't want to read the file over and over again.
2838
2230.3.32 by Aaron Bentley
Implement strict history policy
2839
    def _check_history_violation(self, revision_id):
5718.8.23 by Jelmer Vernooij
Avoid Branch._lefthand_history when checking for history violations.
2840
        current_revid = self.last_revision()
2841
        last_revision = _mod_revision.ensure_null(current_revid)
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
2842
        if _mod_revision.is_null(last_revision):
2230.3.32 by Aaron Bentley
Implement strict history policy
2843
            return
5718.8.23 by Jelmer Vernooij
Avoid Branch._lefthand_history when checking for history violations.
2844
        graph = self.repository.get_graph()
2845
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2846
            if lh_ancestor == current_revid:
2847
                return
2848
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2230.3.32 by Aaron Bentley
Implement strict history policy
2849
2230.4.1 by Aaron Bentley
Get log as fast branch5
2850
    def _gen_revision_history(self):
2230.3.2 by Aaron Bentley
Get all branch tests passing
2851
        """Generate the revision history from last revision
2852
        """
3495.2.1 by Aaron Bentley
Tolerate ghosts in mainline (#235055)
2853
        last_revno, last_revision = self.last_revision_info()
2854
        self._extend_partial_history(stop_index=last_revno-1)
3298.2.10 by Aaron Bentley
Refactor partial history code
2855
        return list(reversed(self._partial_revision_history_cache))
2856
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2857
    @needs_write_lock
2858
    def _set_parent_location(self, url):
2859
        """Set the parent branch"""
2860
        self._set_config_location('parent_location', url, make_relative=True)
2230.3.3 by Aaron Bentley
Add more config testing
2861
2862
    @needs_read_lock
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2863
    def _get_parent_location(self):
2230.3.3 by Aaron Bentley
Add more config testing
2864
        """Set the parent branch"""
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2865
        return self._get_config_location('parent_location')
2230.3.3 by Aaron Bentley
Add more config testing
2866
4273.1.15 by Aaron Bentley
Add reference_info caching.
2867
    @needs_write_lock
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
2868
    def _set_all_reference_info(self, info_dict):
2869
        """Replace all reference info stored in a branch.
2870
2871
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2872
        """
2873
        s = StringIO()
2874
        writer = rio.RioWriter(s)
2875
        for key, (tree_path, branch_location) in info_dict.iteritems():
2876
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2877
                                branch_location=branch_location)
2878
            writer.write_stanza(stanza)
2879
        self._transport.put_bytes('references', s.getvalue())
4273.1.15 by Aaron Bentley
Add reference_info caching.
2880
        self._reference_info = info_dict
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
2881
4273.1.15 by Aaron Bentley
Add reference_info caching.
2882
    @needs_read_lock
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
2883
    def _get_all_reference_info(self):
2884
        """Return all the reference info stored in a branch.
2885
2886
        :return: A dict of {file_id: (tree_path, branch_location)}
2887
        """
4273.1.15 by Aaron Bentley
Add reference_info caching.
2888
        if self._reference_info is not None:
2889
            return self._reference_info
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2890
        rio_file = self._transport.get('references')
2891
        try:
2892
            stanzas = rio.read_stanzas(rio_file)
2893
            info_dict = dict((s['file_id'], (s['tree_path'],
2894
                             s['branch_location'])) for s in stanzas)
2895
        finally:
2896
            rio_file.close()
4273.1.15 by Aaron Bentley
Add reference_info caching.
2897
        self._reference_info = info_dict
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2898
        return info_dict
2899
2900
    def set_reference_info(self, file_id, tree_path, branch_location):
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
2901
        """Set the branch location to use for a tree reference.
2902
2903
        :param file_id: The file-id of the tree reference.
2904
        :param tree_path: The path of the tree reference in the tree.
2905
        :param branch_location: The location of the branch to retrieve tree
2906
            references from.
2907
        """
2908
        info_dict = self._get_all_reference_info()
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2909
        info_dict[file_id] = (tree_path, branch_location)
2910
        if None in (tree_path, branch_location):
2911
            if tree_path is not None:
2912
                raise ValueError('tree_path must be None when branch_location'
2913
                                 ' is None.')
2914
            if branch_location is not None:
2915
                raise ValueError('branch_location must be None when tree_path'
2916
                                 ' is None.')
2917
            del info_dict[file_id]
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
2918
        self._set_all_reference_info(info_dict)
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2919
2920
    def get_reference_info(self, file_id):
4273.1.11 by Aaron Bentley
Clean up naming and docstrings
2921
        """Get the tree_path and branch_location for a tree reference.
2922
2923
        :return: a tuple of (tree_path, branch_location)
2924
        """
2925
        return self._get_all_reference_info().get(file_id, (None, None))
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2926
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
2927
    def reference_parent(self, file_id, path, possible_transports=None):
4273.1.2 by Aaron Bentley
Use reference_info to get reference_parent.
2928
        """Return the parent branch for a tree-reference file_id.
2929
2930
        :param file_id: The file_id of the tree reference
2931
        :param path: The path of the file_id in the tree
2932
        :return: A branch associated with the file_id
2933
        """
2934
        branch_location = self.get_reference_info(file_id)[1]
2935
        if branch_location is None:
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
2936
            return Branch.reference_parent(self, file_id, path,
2937
                                           possible_transports)
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
2938
        branch_location = urlutils.join(self.user_url, branch_location)
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
2939
        return Branch.open(branch_location,
2940
                           possible_transports=possible_transports)
4273.1.2 by Aaron Bentley
Use reference_info to get reference_parent.
2941
2230.3.3 by Aaron Bentley
Add more config testing
2942
    def set_push_location(self, location):
2943
        """See Branch.set_push_location."""
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2944
        self._set_config_location('push_location', location)
2230.3.3 by Aaron Bentley
Add more config testing
2945
2946
    def set_bound_location(self, location):
2947
        """See Branch.set_push_location."""
5609.25.5 by Andrew Bennetts
Add tests that get_master_branch isn't cached when it shouldn't be, and fix a bug that reveals.
2948
        self._master_branch_cache = None
2230.3.7 by Aaron Bentley
Fix binding return values
2949
        result = None
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2950
        config = self.get_config()
2230.3.6 by Aaron Bentley
work in progress bind stuff
2951
        if location is None:
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2952
            if config.get_user_option('bound') != 'True':
2230.3.7 by Aaron Bentley
Fix binding return values
2953
                return False
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2954
            else:
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
2955
                config.set_user_option('bound', 'False', warn_masked=True)
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2956
                return True
2957
        else:
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2958
            self._set_config_location('bound_location', location,
2959
                                      config=config)
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
2960
            config.set_user_option('bound', 'True', warn_masked=True)
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2961
        return True
2962
2963
    def _get_bound_location(self, bound):
2964
        """Return the bound location in the config file.
2965
2966
        Return None if the bound parameter does not match"""
2967
        config = self.get_config()
2968
        config_bound = (config.get_user_option('bound') == 'True')
2969
        if config_bound != bound:
2970
            return None
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2971
        return self._get_config_location('bound_location', config=config)
2230.3.3 by Aaron Bentley
Add more config testing
2972
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2973
    def get_bound_location(self):
2974
        """See Branch.set_push_location."""
2975
        return self._get_bound_location(True)
2976
2977
    def get_old_bound_location(self):
2978
        """See Branch.get_old_bound_location"""
2979
        return self._get_bound_location(False)
2980
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
2981
    def get_stacked_on_url(self):
3691.2.12 by Martin Pool
Add test for coping without Branch.get_stacked_on_url
2982
        # you can always ask for the URL; but you might not be able to use it
2983
        # if the repo can't support stacking.
2984
        ## self._check_stackable_repo()
5993.4.1 by Andrew Bennetts
Make Branch.open more than 3x faster.
2985
        # stacked_on_location is only ever defined in branch.conf, so don't
2986
        # waste effort reading the whole stack of config files.
2987
        config = self.get_config()._get_branch_data_config()
2988
        stacked_url = self._get_config_location('stacked_on_location',
2989
            config=config)
3221.18.2 by Ian Clatworthy
store stacked-on location in branch.conf
2990
        if stacked_url is None:
3221.11.6 by Robert Collins
Stackable branch fixes.
2991
            raise errors.NotStacked(self)
2992
        return stacked_url
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2993
3060.3.3 by Lukáš Lalinský
Make RevisionSpec_revid and RevisionSpec_revno not load the whole revision history.
2994
    @needs_read_lock
3060.3.2 by Lukáš Lalinský
Make RevisionSpec_last not load the whole history.
2995
    def get_rev_id(self, revno, history=None):
2996
        """Find the revision id of the specified revno."""
2997
        if revno == 0:
2998
            return _mod_revision.NULL_REVISION
2999
3000
        last_revno, last_revision_id = self.last_revision_info()
3001
        if revno <= 0 or revno > last_revno:
3002
            raise errors.NoSuchRevision(self, revno)
3003
3004
        if history is not None:
3298.3.3 by Aaron Bentley
Update from review
3005
            return history[revno - 1]
3060.3.2 by Lukáš Lalinský
Make RevisionSpec_last not load the whole history.
3006
3298.2.10 by Aaron Bentley
Refactor partial history code
3007
        index = last_revno - revno
3298.3.2 by Aaron Bentley
Catch history mismatch, cleanup
3008
        if len(self._partial_revision_history_cache) <= index:
3009
            self._extend_partial_history(stop_index=index)
3298.2.10 by Aaron Bentley
Refactor partial history code
3010
        if len(self._partial_revision_history_cache) > index:
3011
            return self._partial_revision_history_cache[index]
3060.3.6 by Lukáš Lalinský
Implement partial history cache in BzrBranch6.
3012
        else:
3298.2.10 by Aaron Bentley
Refactor partial history code
3013
            raise errors.NoSuchRevision(self, revno)
3060.3.2 by Lukáš Lalinský
Make RevisionSpec_last not load the whole history.
3014
3298.2.12 by Aaron Bentley
Add Branch6.revision_id_to_revno
3015
    @needs_read_lock
3016
    def revision_id_to_revno(self, revision_id):
3017
        """Given a revision id, return its revno"""
3018
        if _mod_revision.is_null(revision_id):
3019
            return 0
3020
        try:
3021
            index = self._partial_revision_history_cache.index(revision_id)
3022
        except ValueError:
5689.2.1 by Jelmer Vernooij
Properly raise GhostsHaveNoRevno in revision_id_to_revno.
3023
            try:
3024
                self._extend_partial_history(stop_revision=revision_id)
3025
            except errors.RevisionNotPresent, e:
3026
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3298.2.12 by Aaron Bentley
Add Branch6.revision_id_to_revno
3027
            index = len(self._partial_revision_history_cache) - 1
3028
            if self._partial_revision_history_cache[index] != revision_id:
3029
                raise errors.NoSuchRevision(self, revision_id)
3030
        return self.revno() - index
3031
2230.3.34 by Aaron Bentley
cleanup
3032
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
3033
class BzrBranch7(BzrBranch8):
3034
    """A branch with support for a fallback repository."""
3035
3036
    def set_reference_info(self, file_id, tree_path, branch_location):
3037
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
3038
3039
    def get_reference_info(self, file_id):
3040
        Branch.get_reference_info(self, file_id)
3041
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
3042
    def reference_parent(self, file_id, path, possible_transports=None):
3043
        return Branch.reference_parent(self, file_id, path,
3044
                                       possible_transports)
4273.1.2 by Aaron Bentley
Use reference_info to get reference_parent.
3045
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
3046
3221.11.2 by Robert Collins
Create basic stackable branch facility.
3047
class BzrBranch6(BzrBranch7):
3048
    """See BzrBranchFormat6 for the capabilities of this branch.
3049
3221.18.1 by Ian Clatworthy
tweaks by ianc during review
3050
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3051
    i.e. stacking.
3221.11.2 by Robert Collins
Create basic stackable branch facility.
3052
    """
3053
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
3054
    def get_stacked_on_url(self):
5158.6.3 by Martin Pool
Update some Branch calls to use ControlComponent style.
3055
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
3056
3057
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
3058
######################################################################
3059
# results of operations
3060
2220.2.37 by Martin Pool
Report conflicting tags from push.
3061
3062
class _Result(object):
3063
3064
    def _show_tag_conficts(self, to_file):
3065
        if not getattr(self, 'tag_conflicts', None):
3066
            return
3067
        to_file.write('Conflicting tags:\n')
3068
        for name, value1, value2 in self.tag_conflicts:
3069
            to_file.write('    %s\n' % (name, ))
3070
3071
3072
class PullResult(_Result):
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
3073
    """Result of a Branch.pull operation.
3074
3075
    :ivar old_revno: Revision number before pull.
3076
    :ivar new_revno: Revision number after pull.
3077
    :ivar old_revid: Tip revision id before pull.
3078
    :ivar new_revid: Tip revision id after pull.
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
3079
    :ivar source_branch: Source (local) branch object. (read locked)
3482.1.1 by John Arbash Meinel
Fix bug #238149, RemoteBranch.pull needs to return the _real_branch's pull result.
3080
    :ivar master_branch: Master branch of the target, or the target if no
3081
        Master
3082
    :ivar local_branch: target branch if there is a Master, else None
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
3083
    :ivar target_branch: Target/destination branch object. (write locked)
3482.1.1 by John Arbash Meinel
Fix bug #238149, RemoteBranch.pull needs to return the _real_branch's pull result.
3084
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
6112.4.1 by Jelmer Vernooij
Show how many tags have been updated in bzr pull.
3085
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
3086
    """
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
3087
5348.1.2 by Martin Pool
Deprecate casting PushResult and PullResult to int to get the relative revno change
3088
    @deprecated_method(deprecated_in((2, 3, 0)))
2297.1.3 by Martin Pool
PullResult can pretend to be an int for api compatibility with old .pull()
3089
    def __int__(self):
5348.1.2 by Martin Pool
Deprecate casting PushResult and PullResult to int to get the relative revno change
3090
        """Return the relative change in revno.
3091
3092
        :deprecated: Use `new_revno` and `old_revno` instead.
3093
        """
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
3094
        return self.new_revno - self.old_revno
3095
2220.2.39 by Martin Pool
Pull also merges tags and warns if they conflict
3096
    def report(self, to_file):
6112.4.3 by Jelmer Vernooij
Fix push tests.
3097
        tag_conflicts = getattr(self, "tag_conflicts", None)
3098
        tag_updates = getattr(self, "tag_updates", None)
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
3099
        if not is_quiet():
6112.4.1 by Jelmer Vernooij
Show how many tags have been updated in bzr pull.
3100
            if self.old_revid != self.new_revid:
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
3101
                to_file.write('Now on revision %d.\n' % self.new_revno)
6112.4.3 by Jelmer Vernooij
Fix push tests.
3102
            if tag_updates:
3103
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3104
            if self.old_revid == self.new_revid and not tag_updates:
3105
                if not tag_conflicts:
6112.4.1 by Jelmer Vernooij
Show how many tags have been updated in bzr pull.
3106
                    to_file.write('No revisions or tags to pull.\n')
3107
                else:
3108
                    to_file.write('No revisions to pull.\n')
2220.2.39 by Martin Pool
Pull also merges tags and warns if they conflict
3109
        self._show_tag_conficts(to_file)
3110
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
3111
4053.3.1 by Jelmer Vernooij
Rename PushResult to BranchPushResult.
3112
class BranchPushResult(_Result):
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
3113
    """Result of a Branch.push operation.
3114
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
3115
    :ivar old_revno: Revision number (eg 10) of the target before push.
3116
    :ivar new_revno: Revision number (eg 12) of the target after push.
3117
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3118
        before the push.
3119
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3120
        after the push.
3121
    :ivar source_branch: Source branch object that the push was from. This is
3122
        read locked, and generally is a local (and thus low latency) branch.
3123
    :ivar master_branch: If target is a bound branch, the master branch of
3124
        target, or target itself. Always write locked.
3125
    :ivar target_branch: The direct Branch where data is being sent (write
3126
        locked).
3127
    :ivar local_branch: If the target is a bound branch this will be the
3128
        target, otherwise it will be None.
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
3129
    """
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
3130
5348.1.2 by Martin Pool
Deprecate casting PushResult and PullResult to int to get the relative revno change
3131
    @deprecated_method(deprecated_in((2, 3, 0)))
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
3132
    def __int__(self):
5348.1.2 by Martin Pool
Deprecate casting PushResult and PullResult to int to get the relative revno change
3133
        """Return the relative change in revno.
3134
3135
        :deprecated: Use `new_revno` and `old_revno` instead.
3136
        """
2297.1.3 by Martin Pool
PullResult can pretend to be an int for api compatibility with old .pull()
3137
        return self.new_revno - self.old_revno
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
3138
2220.2.37 by Martin Pool
Report conflicting tags from push.
3139
    def report(self, to_file):
6112.4.5 by Jelmer Vernooij
Add note about bzr pull / bzr push output inconsistency.
3140
        # TODO: This function gets passed a to_file, but then
3141
        # ignores it and calls note() instead. This is also
3142
        # inconsistent with PullResult(), which writes to stdout.
3143
        # -- JRV20110901, bug #838853
6112.4.3 by Jelmer Vernooij
Fix push tests.
3144
        tag_conflicts = getattr(self, "tag_conflicts", None)
3145
        tag_updates = getattr(self, "tag_updates", None)
6112.4.2 by Jelmer Vernooij
Fix tag tests.
3146
        if not is_quiet():
3147
            if self.old_revid != self.new_revid:
6138.3.1 by Jonathan Riddell
use gettext() in more files
3148
                note(gettext('Pushed up to revision %d.') % self.new_revno)
6112.4.3 by Jelmer Vernooij
Fix push tests.
3149
            if tag_updates:
6143.1.1 by Jonathan Riddell
use ngettext for plurals
3150
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
6112.4.3 by Jelmer Vernooij
Fix push tests.
3151
            if self.old_revid == self.new_revid and not tag_updates:
3152
                if not tag_conflicts:
6138.3.1 by Jonathan Riddell
use gettext() in more files
3153
                    note(gettext('No new revisions or tags to push.'))
6112.4.2 by Jelmer Vernooij
Fix tag tests.
3154
                else:
6138.3.1 by Jonathan Riddell
use gettext() in more files
3155
                    note(gettext('No new revisions to push.'))
2220.2.37 by Martin Pool
Report conflicting tags from push.
3156
        self._show_tag_conficts(to_file)
3157
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
3158
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
3159
class BranchCheckResult(object):
3160
    """Results of checking branch consistency.
3161
3162
    :see: Branch.check
3163
    """
3164
3165
    def __init__(self, branch):
3166
        self.branch = branch
4332.3.3 by Robert Collins
Alter Branch.check to log errors rather than raising.
3167
        self.errors = []
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
3168
3169
    def report_results(self, verbose):
3170
        """Report the check results via trace.note.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3171
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
3172
        :param verbose: Requests more detailed display of what was checked,
3173
            if any.
3174
        """
6147.1.1 by Jonathan Riddell
use .format() instead of % for string formatting where there are multiple formats in one string to allow for translations
3175
        note(gettext('checked branch {0} format {1}').format(
3176
                                self.branch.user_url, self.branch._format))
4332.3.3 by Robert Collins
Alter Branch.check to log errors rather than raising.
3177
        for error in self.errors:
6138.3.1 by Jonathan Riddell
use gettext() in more files
3178
            note(gettext('found error:%s'), error)
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
3179
3180
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
3181
class Converter5to6(object):
3182
    """Perform an in-place upgrade of format 5 to format 6"""
3183
3184
    def convert(self, branch):
3185
        # Data for 5 and 6 can peacefully coexist.
3186
        format = BzrBranchFormat6()
3187
        new_branch = format.open(branch.bzrdir, _found=True)
3188
3189
        # Copy source data into target
3331.1.15 by Andrew Bennetts
Use _write_last_revision_info rather than set_last_revision_info in Converter5to6, because we just want to write the last-revision file, not trigger hooks with half-converted branches.
3190
        new_branch._write_last_revision_info(*branch.last_revision_info())
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
3191
        new_branch.set_parent(branch.get_parent())
3192
        new_branch.set_bound_location(branch.get_bound_location())
3193
        new_branch.set_push_location(branch.get_push_location())
3194
2220.2.43 by Martin Pool
Should clear tag file when upgrading format 5 to 6 to prevent warning
3195
        # New branch has no tags by default
3196
        new_branch.tags._set_tag_dict({})
3197
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
3198
        # Copying done; now update target format
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
3199
        new_branch._transport.put_bytes('format',
3200
            format.get_format_string(),
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
3201
            mode=new_branch.bzrdir._get_file_mode())
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
3202
3203
        # Clean up old files
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
3204
        new_branch._transport.delete('revision-history')
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
3205
        try:
3206
            branch.set_parent(None)
3236.1.2 by Michael Hudson
clean up branch.py imports
3207
        except errors.NoSuchFile:
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
3208
            pass
3209
        branch.set_bound_location(None)
3221.11.4 by Robert Collins
Add a converter for format 7 branches.
3210
3211
3212
class Converter6to7(object):
3213
    """Perform an in-place upgrade of format 6 to format 7"""
3214
3215
    def convert(self, branch):
3221.11.5 by Robert Collins
Correctly handle multi-step branch upgrades.
3216
        format = BzrBranchFormat7()
3221.18.2 by Ian Clatworthy
store stacked-on location in branch.conf
3217
        branch._set_config_location('stacked_on_location', '')
3221.11.4 by Robert Collins
Add a converter for format 7 branches.
3218
        # update target format
3221.13.5 by Ian Clatworthy
fix LockableFiles deprecations
3219
        branch._transport.put_bytes('format', format.get_format_string())
3758.1.1 by Andrew Bennetts
Fix #230902 by being more careful not to squash a pre-existing exception when calling foo.unlock()
3220
3221
4273.1.13 by Aaron Bentley
Implement upgrade from branch format 7 to 8.
3222
class Converter7to8(object):
5906.1.1 by Jelmer Vernooij
Remove unused constants, fix docstring.
3223
    """Perform an in-place upgrade of format 7 to format 8"""
4273.1.13 by Aaron Bentley
Implement upgrade from branch format 7 to 8.
3224
3225
    def convert(self, branch):
3226
        format = BzrBranchFormat8()
3227
        branch._transport.put_bytes('references', '')
3228
        # update target format
3229
        branch._transport.put_bytes('format', format.get_format_string())
3230
3758.1.1 by Andrew Bennetts
Fix #230902 by being more careful not to squash a pre-existing exception when calling foo.unlock()
3231
4000.5.1 by Jelmer Vernooij
Add InterBranch.
3232
class InterBranch(InterObject):
3233
    """This class represents operations taking place between two branches.
3234
3235
    Its instances have methods like pull() and push() and contain
3236
    references to the source and target repositories these operations
3237
    can be carried out on.
3238
    """
3239
3240
    _optimisers = []
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
3241
    """The available optimised InterBranch types."""
3242
5297.2.1 by Robert Collins
``bzrlib.branch.InterBranch._get_branch_formats_to_test`` now returns
3243
    @classmethod
3244
    def _get_branch_formats_to_test(klass):
3245
        """Return an iterable of format tuples for testing.
3246
        
3247
        :return: An iterable of (from_format, to_format) to use when testing
3248
            this InterBranch class. Each InterBranch class should define this
3249
            method itself.
3250
        """
3251
        raise NotImplementedError(klass._get_branch_formats_to_test)
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
3252
5297.2.2 by Robert Collins
Fixup tests in per_interbranch not being strict about making the from format the configured one.
3253
    @needs_write_lock
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3254
    def pull(self, overwrite=False, stop_revision=None,
4000.5.21 by Jelmer Vernooij
Merge bzr.dev.
3255
             possible_transports=None, local=False):
4000.5.10 by Jelmer Vernooij
Fix comment for InterBranch.pull.
3256
        """Mirror source into target branch.
3257
3258
        The target branch is considered to be 'local', having low latency.
3259
3260
        :returns: PullResult instance
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3261
        """
3262
        raise NotImplementedError(self.pull)
3263
5297.2.2 by Robert Collins
Fixup tests in per_interbranch not being strict about making the from format the configured one.
3264
    @needs_write_lock
5853.2.2 by Jelmer Vernooij
Make lossy_push an argument to InterBranch.push.
3265
    def push(self, overwrite=False, stop_revision=None, lossy=False,
4211.1.3 by Jelmer Vernooij
Fix trailing whitespace, add prototype for InterBranch.push().
3266
             _override_hook_source_branch=None):
3267
        """Mirror the source branch into the target branch.
3268
3269
        The source branch is considered to be 'local', having low latency.
3270
        """
3271
        raise NotImplementedError(self.push)
3272
5358.1.1 by Jelmer Vernooij
Add stub for InterBranch.copy_content_into.
3273
    @needs_write_lock
3274
    def copy_content_into(self, revision_id=None):
3275
        """Copy the content of source into target
3276
3277
        revision_id: if not None, the revision history in the new branch will
3278
                     be truncated to end with revision_id.
3279
        """
3280
        raise NotImplementedError(self.copy_content_into)
3281
5741.1.1 by Jelmer Vernooij
Move fetch implementation to InterBranch.
3282
    @needs_write_lock
5852.1.1 by Jelmer Vernooij
Add limit argument to Branch.fetch.
3283
    def fetch(self, stop_revision=None, limit=None):
5741.1.1 by Jelmer Vernooij
Move fetch implementation to InterBranch.
3284
        """Fetch revisions.
3285
3286
        :param stop_revision: Last revision to fetch
5852.1.1 by Jelmer Vernooij
Add limit argument to Branch.fetch.
3287
        :param limit: Optional rough limit of revisions to fetch
5741.1.1 by Jelmer Vernooij
Move fetch implementation to InterBranch.
3288
        """
3289
        raise NotImplementedError(self.fetch)
3290
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
3291
3292
class GenericInterBranch(InterBranch):
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3293
    """InterBranch implementation that uses public Branch functions."""
3294
3295
    @classmethod
3296
    def is_compatible(klass, source, target):
3297
        # GenericBranch uses the public API, so always compatible
3298
        return True
4000.5.1 by Jelmer Vernooij
Add InterBranch.
3299
5297.2.1 by Robert Collins
``bzrlib.branch.InterBranch._get_branch_formats_to_test`` now returns
3300
    @classmethod
3301
    def _get_branch_formats_to_test(klass):
5662.2.2 by Jelmer Vernooij
Move most format registration functions to BranchFormatRegistry.
3302
        return [(format_registry.get_default(), format_registry.get_default())]
4000.5.3 by Jelmer Vernooij
Add tests for InterBranch.
3303
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3304
    @classmethod
3305
    def unwrap_format(klass, format):
3306
        if isinstance(format, remote.RemoteBranchFormat):
3307
            format._ensure_real()
3308
            return format._custom_format
5050.53.4 by Andrew Bennetts
Don't propagate tags to the master branch during cmd_merge.
3309
        return format
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3310
5284.4.2 by Robert Collins
* ``Branch.copy_content_into`` is now a convenience method dispatching to
3311
    @needs_write_lock
3312
    def copy_content_into(self, revision_id=None):
3313
        """Copy the content of source into target
3314
3315
        revision_id: if not None, the revision history in the new branch will
3316
                     be truncated to end with revision_id.
3317
        """
3318
        self.source.update_references(self.target)
3319
        self.source._synchronize_history(self.target, revision_id)
3320
        try:
3321
            parent = self.source.get_parent()
3322
        except errors.InaccessibleParent, e:
3323
            mutter('parent was not accessible to copy: %s', e)
3324
        else:
3325
            if parent:
3326
                self.target.set_parent(parent)
3327
        if self.source._push_should_merge_tags():
5284.4.3 by Robert Collins
Fix missed self.source change in copy_content_into.
3328
            self.source.tags.merge_to(self.target.tags)
5284.4.2 by Robert Collins
* ``Branch.copy_content_into`` is now a convenience method dispatching to
3329
3330
    @needs_write_lock
5852.1.1 by Jelmer Vernooij
Add limit argument to Branch.fetch.
3331
    def fetch(self, stop_revision=None, limit=None):
5741.1.1 by Jelmer Vernooij
Move fetch implementation to InterBranch.
3332
        if self.target.base == self.source.base:
3333
            return (0, [])
3334
        self.source.lock_read()
3335
        try:
5741.1.6 by Jelmer Vernooij
Add stop_revision argument to Branch.heads_to_fetch.
3336
            fetch_spec_factory = fetch.FetchSpecFactory()
3337
            fetch_spec_factory.source_branch = self.source
3338
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3339
            fetch_spec_factory.source_repo = self.source.repository
3340
            fetch_spec_factory.target_repo = self.target.repository
3341
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
5852.1.5 by Andrew Bennetts, Jelmer Vernooij
Support limit= for fetching between Bazaar branches.
3342
            fetch_spec_factory.limit = limit
5741.1.6 by Jelmer Vernooij
Add stop_revision argument to Branch.heads_to_fetch.
3343
            fetch_spec = fetch_spec_factory.make_fetch_spec()
5741.1.1 by Jelmer Vernooij
Move fetch implementation to InterBranch.
3344
            return self.target.repository.fetch(self.source.repository,
5741.1.4 by Jelmer Vernooij
Change Branch.fetch to take fetch_tags argument rather than fetch_spec.
3345
                fetch_spec=fetch_spec)
5741.1.1 by Jelmer Vernooij
Move fetch implementation to InterBranch.
3346
        finally:
3347
            self.source.unlock()
3348
5809.2.1 by Jelmer Vernooij
Deprecate Branch.update_revisions.
3349
    @needs_write_lock
3350
    def _update_revisions(self, stop_revision=None, overwrite=False,
5809.2.4 by Jelmer Vernooij
remove unused argument.
3351
            graph=None):
5284.4.2 by Robert Collins
* ``Branch.copy_content_into`` is now a convenience method dispatching to
3352
        other_revno, other_last_revision = self.source.last_revision_info()
3353
        stop_revno = None # unknown
3354
        if stop_revision is None:
3355
            stop_revision = other_last_revision
3356
            if _mod_revision.is_null(stop_revision):
3357
                # if there are no commits, we're done.
3358
                return
3359
            stop_revno = other_revno
4000.5.1 by Jelmer Vernooij
Add InterBranch.
3360
5284.4.2 by Robert Collins
* ``Branch.copy_content_into`` is now a convenience method dispatching to
3361
        # what's the current last revision, before we fetch [and change it
3362
        # possibly]
3363
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3364
        # we fetch here so that we don't process data twice in the common
3365
        # case of having something to pull, and so that the check for
3366
        # already merged can operate on the just fetched graph, which will
3367
        # be cached in memory.
5741.1.8 by Jelmer Vernooij
Remove fetch_tags argument.
3368
        self.fetch(stop_revision=stop_revision)
5284.4.2 by Robert Collins
* ``Branch.copy_content_into`` is now a convenience method dispatching to
3369
        # Check to see if one is an ancestor of the other
3370
        if not overwrite:
3371
            if graph is None:
3372
                graph = self.target.repository.get_graph()
3373
            if self.target._check_if_descendant_or_diverged(
3374
                    stop_revision, last_rev, graph, self.source):
3375
                # stop_revision is a descendant of last_rev, but we aren't
3376
                # overwriting, so we're done.
3377
                return
3378
        if stop_revno is None:
3379
            if graph is None:
3380
                graph = self.target.repository.get_graph()
3381
            this_revno, this_last_revision = \
3382
                    self.target.last_revision_info()
3383
            stop_revno = graph.find_distance_to_null(stop_revision,
3384
                            [(other_last_revision, other_revno),
3385
                             (this_last_revision, this_revno)])
3386
        self.target.set_last_revision_info(stop_revno, stop_revision)
4000.5.1 by Jelmer Vernooij
Add InterBranch.
3387
5297.2.2 by Robert Collins
Fixup tests in per_interbranch not being strict about making the from format the configured one.
3388
    @needs_write_lock
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3389
    def pull(self, overwrite=False, stop_revision=None,
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3390
             possible_transports=None, run_hooks=True,
4000.5.21 by Jelmer Vernooij
Merge bzr.dev.
3391
             _override_hook_target=None, local=False):
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3392
        """Pull from source into self, updating my master if any.
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3393
3394
        :param run_hooks: Private parameter - if false, this branch
3395
            is being called because it's the master of the primary branch,
3396
            so it should not run its hooks.
3397
        """
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3398
        bound_location = self.target.get_bound_location()
3399
        if local and not bound_location:
4000.5.21 by Jelmer Vernooij
Merge bzr.dev.
3400
            raise errors.LocalRequiresBoundBranch()
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3401
        master_branch = None
5609.50.1 by Vincent Ladeuil
Be more tolerant about ``bound_location`` from config files
3402
        source_is_master = False
3403
        if bound_location:
5609.50.2 by Vincent Ladeuil
Fix typos caught by Jonathan.
3404
            # bound_location comes from a config file, some care has to be
3405
            # taken to relate it to source.user_url
5609.50.1 by Vincent Ladeuil
Be more tolerant about ``bound_location`` from config files
3406
            normalized = urlutils.normalize_url(bound_location)
3407
            try:
3408
                relpath = self.source.user_transport.relpath(normalized)
3409
                source_is_master = (relpath == '')
3410
            except (errors.PathNotChild, errors.InvalidURL):
3411
                source_is_master = False
5582.5.1 by John Arbash Meinel
Fix bug 701212. Don't set the tags for a master branch during update.
3412
        if not local and bound_location and not source_is_master:
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3413
            # not pulling from master, so we need to update master.
3414
            master_branch = self.target.get_master_branch(possible_transports)
3415
            master_branch.lock_write()
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3416
        try:
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3417
            if master_branch:
3418
                # pull from source into master.
3419
                master_branch.pull(self.source, overwrite, stop_revision,
3420
                    run_hooks=False)
3421
            return self._pull(overwrite,
3422
                stop_revision, _hook_master=master_branch,
3423
                run_hooks=run_hooks,
5582.5.1 by John Arbash Meinel
Fix bug 701212. Don't set the tags for a master branch during update.
3424
                _override_hook_target=_override_hook_target,
3425
                merge_tags_to_master=not source_is_master)
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3426
        finally:
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3427
            if master_branch:
3428
                master_branch.unlock()
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3429
5853.2.2 by Jelmer Vernooij
Make lossy_push an argument to InterBranch.push.
3430
    def push(self, overwrite=False, stop_revision=None, lossy=False,
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3431
             _override_hook_source_branch=None):
3432
        """See InterBranch.push.
3433
3434
        This is the basic concrete implementation of push()
3435
5891.1.2 by Andrew Bennetts
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.
3436
        :param _override_hook_source_branch: If specified, run the hooks
3437
            passing this Branch as the source, rather than self.  This is for
3438
            use of RemoteBranch, where push is delegated to the underlying
3439
            vfs-based Branch.
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3440
        """
5853.2.2 by Jelmer Vernooij
Make lossy_push an argument to InterBranch.push.
3441
        if lossy:
3442
            raise errors.LossyPushToSameVCS(self.source, self.target)
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3443
        # TODO: Public option to disable running hooks - should be trivial but
3444
        # needs tests.
5915.1.1 by Andrew Bennetts
Removed bzrlib.branch._run_with_write_locked_target. Use bzrlib.cleanup instead.
3445
3446
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3447
        op.add_cleanup(self.source.lock_read().unlock)
3448
        op.add_cleanup(self.target.lock_write().unlock)
3449
        return op.run(overwrite, stop_revision,
3450
            _override_hook_source_branch=_override_hook_source_branch)
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3451
5809.2.3 by Jelmer Vernooij
Kill update_revisions private implementation.
3452
    def _basic_push(self, overwrite, stop_revision):
3453
        """Basic implementation of push without bound branches or hooks.
3454
3455
        Must be called with source read locked and target write locked.
3456
        """
3457
        result = BranchPushResult()
3458
        result.source_branch = self.source
3459
        result.target_branch = self.target
3460
        result.old_revno, result.old_revid = self.target.last_revision_info()
3461
        self.source.update_references(self.target)
3462
        if result.old_revid != stop_revision:
3463
            # We assume that during 'push' this repository is closer than
3464
            # the target.
3465
            graph = self.source.repository.get_graph(self.target.repository)
3466
            self._update_revisions(stop_revision, overwrite=overwrite,
3467
                    graph=graph)
3468
        if self.source._push_should_merge_tags():
6112.4.4 by Jelmer Vernooij
Fix long lines.
3469
            result.tag_updates, result.tag_conflicts = (
3470
                self.source.tags.merge_to(self.target.tags, overwrite))
5809.2.3 by Jelmer Vernooij
Kill update_revisions private implementation.
3471
        result.new_revno, result.new_revid = self.target.last_revision_info()
3472
        return result
3473
5915.1.1 by Andrew Bennetts
Removed bzrlib.branch._run_with_write_locked_target. Use bzrlib.cleanup instead.
3474
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3475
            _override_hook_source_branch=None):
3476
        """Push from source into target, and into target's master if any.
3477
        """
3478
        def _run_hooks():
3479
            if _override_hook_source_branch:
3480
                result.source_branch = _override_hook_source_branch
3481
            for hook in Branch.hooks['post_push']:
3482
                hook(result)
3483
3484
        bound_location = self.target.get_bound_location()
3485
        if bound_location and self.target.base != bound_location:
3486
            # there is a master branch.
3487
            #
3488
            # XXX: Why the second check?  Is it even supported for a branch to
3489
            # be bound to itself? -- mbp 20070507
3490
            master_branch = self.target.get_master_branch()
3491
            master_branch.lock_write()
5915.1.1 by Andrew Bennetts
Removed bzrlib.branch._run_with_write_locked_target. Use bzrlib.cleanup instead.
3492
            operation.add_cleanup(master_branch.unlock)
3493
            # push into the master from the source branch.
3494
            master_inter = InterBranch.get(self.source, master_branch)
3495
            master_inter._basic_push(overwrite, stop_revision)
3496
            # and push into the target branch from the source. Note that
3497
            # we push from the source branch again, because it's considered
3498
            # the highest bandwidth repository.
3499
            result = self._basic_push(overwrite, stop_revision)
3500
            result.master_branch = master_branch
3501
            result.local_branch = self.target
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3502
        else:
5915.1.1 by Andrew Bennetts
Removed bzrlib.branch._run_with_write_locked_target. Use bzrlib.cleanup instead.
3503
            master_branch = None
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3504
            # no master branch
5809.2.3 by Jelmer Vernooij
Kill update_revisions private implementation.
3505
            result = self._basic_push(overwrite, stop_revision)
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3506
            # TODO: Why set master_branch and local_branch if there's no
3507
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3508
            # 20070504
3509
            result.master_branch = self.target
3510
            result.local_branch = None
5915.1.1 by Andrew Bennetts
Removed bzrlib.branch._run_with_write_locked_target. Use bzrlib.cleanup instead.
3511
        _run_hooks()
3512
        return result
4211.1.1 by Jelmer Vernooij
Move Branch.push to InterBranch.push.
3513
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3514
    def _pull(self, overwrite=False, stop_revision=None,
3515
             possible_transports=None, _hook_master=None, run_hooks=True,
5582.5.1 by John Arbash Meinel
Fix bug 701212. Don't set the tags for a master branch during update.
3516
             _override_hook_target=None, local=False,
3517
             merge_tags_to_master=True):
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3518
        """See Branch.pull.
3519
3520
        This function is the core worker, used by GenericInterBranch.pull to
3521
        avoid duplication when pulling source->master and source->local.
3522
3523
        :param _hook_master: Private parameter - set the branch to
3524
            be supplied as the master to pull hooks.
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3525
        :param run_hooks: Private parameter - if false, this branch
3526
            is being called because it's the master of the primary branch,
3527
            so it should not run its hooks.
5662.2.6 by Jelmer Vernooij
add more tests.
3528
            is being called because it's the master of the primary branch,
3529
            so it should not run its hooks.
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3530
        :param _override_hook_target: Private parameter - set the branch to be
3531
            supplied as the target_branch to pull hooks.
3532
        :param local: Only update the local branch, and not the bound branch.
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3533
        """
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3534
        # This type of branch can't be bound.
3535
        if local:
4000.5.21 by Jelmer Vernooij
Merge bzr.dev.
3536
            raise errors.LocalRequiresBoundBranch()
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3537
        result = PullResult()
3538
        result.source_branch = self.source
3539
        if _override_hook_target is None:
3540
            result.target_branch = self.target
3541
        else:
3542
            result.target_branch = _override_hook_target
3543
        self.source.lock_read()
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3544
        try:
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3545
            # We assume that during 'pull' the target repository is closer than
3546
            # the source one.
3547
            self.source.update_references(self.target)
3548
            graph = self.target.repository.get_graph(self.source.repository)
3549
            # TODO: Branch formats should have a flag that indicates 
3550
            # that revno's are expensive, and pull() should honor that flag.
3551
            # -- JRV20090506
3552
            result.old_revno, result.old_revid = \
3553
                self.target.last_revision_info()
5809.2.3 by Jelmer Vernooij
Kill update_revisions private implementation.
3554
            self._update_revisions(stop_revision, overwrite=overwrite,
5809.2.1 by Jelmer Vernooij
Deprecate Branch.update_revisions.
3555
                graph=graph)
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3556
            # TODO: The old revid should be specified when merging tags, 
3557
            # so a tags implementation that versions tags can only 
3558
            # pull in the most recent changes. -- JRV20090506
6112.4.4 by Jelmer Vernooij
Fix long lines.
3559
            result.tag_updates, result.tag_conflicts = (
3560
                self.source.tags.merge_to(self.target.tags, overwrite,
3561
                    ignore_master=not merge_tags_to_master))
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3562
            result.new_revno, result.new_revid = self.target.last_revision_info()
3563
            if _hook_master:
3564
                result.master_branch = _hook_master
3565
                result.local_branch = result.target_branch
3566
            else:
3567
                result.master_branch = result.target_branch
3568
                result.local_branch = None
3569
            if run_hooks:
3570
                for hook in Branch.hooks['post_pull']:
3571
                    hook(result)
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3572
        finally:
5284.4.1 by Robert Collins
* Fetching was slightly confused about the best code to use and was
3573
            self.source.unlock()
3574
        return result
4000.5.9 by Jelmer Vernooij
Add InterBranch.pull().
3575
3576
4000.5.1 by Jelmer Vernooij
Add InterBranch.
3577
InterBranch.register_optimiser(GenericInterBranch)