~bzr-pqm/bzr/bzr.dev

4110.2.5 by Martin Pool
Deprecate passing pbs in to fetch()
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
import sys
20
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
3221.13.2 by Robert Collins
Add a shallow parameter to bzrdir.sprout, which involved fixing a lateny bug in pack to pack fetching with ghost discovery.
23
from itertools import chain
1551.8.4 by Aaron Bentley
Tweak import style
24
from bzrlib import (
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
25
        bzrdir,
26
        cache_utf8,
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,
30
        lockdir,
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
31
        lockable_files,
3287.6.8 by Robert Collins
Reduce code duplication as per review.
32
        repository,
1996.3.12 by John Arbash Meinel
Change how 'revision' is imported to avoid problems later
33
        revision as _mod_revision,
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
34
        rio,
4110.2.5 by Martin Pool
Deprecate passing pbs in to fetch()
35
        symbol_versioning,
1911.2.9 by John Arbash Meinel
Fix accidental import removal
36
        transport,
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
37
        tsort,
1551.8.4 by Aaron Bentley
Tweak import style
38
        ui,
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
39
        urlutils,
1551.8.4 by Aaron Bentley
Tweak import style
40
        )
4226.1.5 by Robert Collins
Reinstate the use of the Branch.get_config_file verb.
41
from bzrlib.config import BranchConfig, TransportConfig
3735.1.2 by Robert Collins
Remove 1.5 series dev formats and document development2 a little better.
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
2220.2.11 by mbp at sourcefrog
Get tag tests working again, stored in the Branch
43
from bzrlib.tag import (
2220.2.20 by Martin Pool
Tag methods now available through Branch.tags.add_tag, etc
44
    BasicTags,
45
    DisabledTags,
2220.2.11 by mbp at sourcefrog
Get tag tests working again, stored in the Branch
46
    )
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
47
""")
48
1534.4.28 by Robert Collins
first cut at merge from integration.
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
50
from bzrlib.hooks import HookPoint, Hooks
3978.3.2 by Jelmer Vernooij
Move most of push to IterGenericBranchBzrDir.
51
from bzrlib.inter import InterObject
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
52
from bzrlib import registry
3407.2.11 by Martin Pool
Deprecate Branch.abspath
53
from bzrlib.symbol_versioning import (
54
    deprecated_in,
55
    deprecated_method,
56
    )
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
1104 by Martin Pool
- Add a simple UIFactory
58
1094 by Martin Pool
- merge aaron's merge improvements 999..1008
59
1186 by Martin Pool
- start implementing v5 format; Branch refuses to operate on old branches
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
2255.2.230 by Robert Collins
Update tree format signatures to mention introducing bzr version.
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
63
64
65
# TODO: Maybe include checks for common corruption of newlines, etc?
1 by mbp at sourcefrog
import from baz patch-364
66
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
1223 by Martin Pool
- store inventories in weave
69
# cache in memory to make this faster.  In general anything can be
1185.65.29 by Robert Collins
Implement final review suggestions.
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
416 by Martin Pool
- bzr log and bzr root now accept an http URL
72
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
73
1 by mbp at sourcefrog
import from baz patch-364
74
######################################################################
75
# branch objects
76
558 by Martin Pool
- All top-level classes inherit from object
77
class Branch(object):
1 by mbp at sourcefrog
import from baz patch-364
78
    """Branch holding a history of revisions.
79
343 by Martin Pool
doc
80
    base
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
81
        Base directory/url of the branch.
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
82
2245.1.2 by Robert Collins
Remove the static DefaultHooks method from Branch, replacing it with a derived dict BranchHooks object, which is easier to use and provides a place to put the policy-checking add method discussed on list.
83
    hooks: An instance of BranchHooks.
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
84
    """
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
85
    # this is really an instance variable - FIXME move it there
86
    # - RBC 20060112
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
87
    base = None
88
89
    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.
90
        self.tags = self._format.make_tags(self)
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
91
        self._revision_history_cache = None
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
92
        self._revision_id_to_revno_cache = None
3949.2.6 by Ian Clatworthy
review feedback from jam
93
        self._partial_revision_id_to_revno_cache = {}
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
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
95
        self._merge_sorted_revisions_cache = None
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
96
        self._open_hook()
3681.1.1 by Robert Collins
Create a new hook Branch.open. (Robert Collins)
97
        hooks = Branch.hooks['open']
98
        for hook in hooks:
99
            hook(self)
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
100
101
    def _open_hook(self):
102
        """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.
103
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
104
    def _activate_fallback_location(self, url):
105
        """Activate the branch/repository from url as a fallback repository."""
106
        self.repository.add_fallback_repository(
107
            self._get_fallback_repository(url))
108
1687.1.8 by Robert Collins
Teach Branch about break_lock.
109
    def break_lock(self):
110
        """Break a lock if one is present from another instance.
111
112
        Uses the ui factory to ask for confirmation if the lock may be from
113
        an active process.
114
115
        This will probe the repository for its lock as well.
116
        """
117
        self.control_files.break_lock()
118
        self.repository.break_lock()
1687.1.10 by Robert Collins
Branch.break_lock should handle bound branches too
119
        master = self.get_master_branch()
120
        if master is not None:
121
            master.break_lock()
1687.1.8 by Robert Collins
Teach Branch about break_lock.
122
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
123
    def _check_stackable_repo(self):
124
        if not self.repository._format.supports_external_lookups:
125
            raise errors.UnstackableRepositoryFormat(self.repository._format,
126
                self.repository.base)
127
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
128
    @staticmethod
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
129
    def open(base, _unsupported=False, possible_transports=None):
1815.1.1 by Jelmer Vernooij
Fix copy-pasted comment.
130
        """Open the branch rooted at base.
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
131
1815.1.1 by Jelmer Vernooij
Fix copy-pasted comment.
132
        For instance, if the branch is at URL/.bzr/branch,
133
        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.
134
        """
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
135
        control = bzrdir.BzrDir.open(base, _unsupported,
136
                                     possible_transports=possible_transports)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
137
        return control.open_branch(_unsupported)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
138
139
    @staticmethod
2485.8.35 by Vincent Ladeuil
Fix pull multiple connections.
140
    def open_from_transport(transport, _unsupported=False):
141
        """Open the branch rooted at transport"""
142
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
143
        return control.open_branch(_unsupported)
144
145
    @staticmethod
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
146
    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
147
        """Open an existing branch which contains url.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
148
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
149
        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
150
151
        Basically we keep looking up until we find the control directory or
152
        run into the root.  If there isn't one, raises NotBranchError.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
153
        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.
154
        format, UnknownFormatError or UnsupportedFormatError are raised.
1442.1.64 by Robert Collins
Branch.open_containing now returns a tuple (Branch, relative-path).
155
        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.
156
        """
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
157
        control, relpath = bzrdir.BzrDir.open_containing(url,
158
                                                         possible_transports)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
159
        return control.open_branch(), relpath
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
160
4032.3.5 by Robert Collins
Move BzrBranch._push_should_merge_tags to Branch.
161
    def _push_should_merge_tags(self):
162
        """Should _basic_push merge this branch's tags into the target?
163
164
        The default implementation returns False if this branch has no tags,
165
        and True the rest of the time.  Subclasses may override this.
166
        """
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.
167
        return self.supports_tags() and self.tags.get_tag_dict()
4032.3.5 by Robert Collins
Move BzrBranch._push_should_merge_tags to Branch.
168
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
169
    def get_config(self):
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
170
        return BranchConfig(self)
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
171
4226.1.5 by Robert Collins
Reinstate the use of the Branch.get_config_file verb.
172
    def _get_config(self):
173
        """Get the concrete config for just the config in this branch.
174
175
        This is not intended for client use; see Branch.get_config for the
176
        public API.
177
178
        Added in 1.14.
179
180
        :return: An object supporting get_option and set_option.
181
        """
182
        raise NotImplementedError(self._get_config)
183
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
184
    def _get_fallback_repository(self, url):
185
        """Get the repository we fallback to at url."""
186
        url = urlutils.join(self.base, url)
187
        a_bzrdir = bzrdir.BzrDir.open(url,
4226.1.4 by Robert Collins
Simplify code in RemoteBranch to use helpers from Branch.
188
            possible_transports=[self.bzrdir.root_transport])
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
189
        return a_bzrdir.open_branch().repository
190
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.
191
    def _get_tags_bytes(self):
192
        """Get the bytes of a serialised tags dict.
193
194
        Note that not all branches support tags, nor do all use the same tags
195
        logic: this method is specific to BasicTags. Other tag implementations
196
        may use the same method name and behave differently, safely, because
197
        of the double-dispatch via
198
        format.make_tags->tags_instance->get_tags_dict.
199
200
        :return: The bytes of the tags file.
201
        :seealso: Branch._set_tags_bytes.
202
        """
203
        return self._transport.get_bytes('tags')
204
3815.3.4 by Marius Kruger
When doing a `commit --local`, don't try to connect to the master branch.
205
    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.
206
        config = self.get_config()
3815.3.4 by Marius Kruger
When doing a `commit --local`, don't try to connect to the master branch.
207
        # explicit overrides master, but don't look for master if local is True
208
        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
209
            try:
210
                master = self.get_master_branch(possible_transports)
211
                if master is not None:
212
                    # return the master branch value
3815.3.3 by Marius Kruger
apply Martin's fix for #293440
213
                    return master.nick
3565.6.10 by Marius Kruger
Silently fall back to local implicit nick if the master is unavailable
214
            except errors.BzrError, e:
215
                # Silently fall back to local implicit nick if the master is
216
                # unavailable
217
                mutter("Could not connect to bound branch, "
218
                    "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.
219
        return config.get_nickname()
1185.35.11 by Aaron Bentley
Added support for branch nicks
220
221
    def _set_nick(self, nick):
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
222
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
1185.35.11 by Aaron Bentley
Added support for branch nicks
223
224
    nick = property(_get_nick, _set_nick)
1694.2.6 by Martin Pool
[merge] bzr.dev
225
226
    def is_locked(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
227
        raise NotImplementedError(self.is_locked)
1694.2.6 by Martin Pool
[merge] bzr.dev
228
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.
229
    def _lefthand_history(self, revision_id, last_rev=None,
230
                          other_branch=None):
231
        if 'evil' in debug.debug_flags:
232
            mutter_callsite(4, "_lefthand_history scales with history.")
233
        # stop_revision must be a descendant of last_revision
234
        graph = self.repository.get_graph()
235
        if last_rev is not None:
236
            if not graph.is_ancestor(last_rev, revision_id):
237
                # our previous tip is not merged into stop_revision
238
                raise errors.DivergedBranches(self, other_branch)
239
        # make a new revision history from the graph
240
        parents_map = graph.get_parent_map([revision_id])
241
        if revision_id not in parents_map:
242
            raise errors.NoSuchRevision(self, revision_id)
243
        current_rev_id = revision_id
244
        new_history = []
245
        check_not_reserved_id = _mod_revision.check_not_reserved_id
246
        # Do not include ghosts or graph origin in revision_history
247
        while (current_rev_id in parents_map and
248
               len(parents_map[current_rev_id]) > 0):
249
            check_not_reserved_id(current_rev_id)
250
            new_history.append(current_rev_id)
251
            current_rev_id = parents_map[current_rev_id][0]
252
            parents_map = graph.get_parent_map([current_rev_id])
253
        new_history.reverse()
254
        return new_history
255
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
256
    def lock_write(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
257
        raise NotImplementedError(self.lock_write)
1694.2.6 by Martin Pool
[merge] bzr.dev
258
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
259
    def lock_read(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
260
        raise NotImplementedError(self.lock_read)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
261
262
    def unlock(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
263
        raise NotImplementedError(self.unlock)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
264
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
265
    def peek_lock_mode(self):
266
        """Return lock mode for the Branch: 'r', 'w' or None"""
1185.70.6 by Martin Pool
review fixups from John
267
        raise NotImplementedError(self.peek_lock_mode)
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
268
1694.2.6 by Martin Pool
[merge] bzr.dev
269
    def get_physical_lock_status(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
270
        raise NotImplementedError(self.get_physical_lock_status)
1694.2.6 by Martin Pool
[merge] bzr.dev
271
2418.5.12 by John Arbash Meinel
Move functions from BzrBranch to base Branch object.
272
    @needs_read_lock
3949.2.6 by Ian Clatworthy
review feedback from jam
273
    def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
274
        """Return the revision_id for a dotted revno.
275
276
        :param revno: a tuple like (1,) or (1,1,2)
3949.2.4 by Ian Clatworthy
add top level revno cache
277
        :param _cache_reverse: a private parameter enabling storage
278
           of the reverse mapping in a top level cache. (This should
279
           only be done in selective circumstances as we want to
280
           avoid having the mapping cached multiple times.)
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
281
        :return: the revision_id
282
        :raises errors.NoSuchRevision: if the revno doesn't exist
283
        """
3949.2.6 by Ian Clatworthy
review feedback from jam
284
        rev_id = self._do_dotted_revno_to_revision_id(revno)
285
        if _cache_reverse:
286
            self._partial_revision_id_to_revno_cache[rev_id] = revno
3949.2.4 by Ian Clatworthy
add top level revno cache
287
        return rev_id
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
288
3949.2.6 by Ian Clatworthy
review feedback from jam
289
    def _do_dotted_revno_to_revision_id(self, revno):
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
290
        """Worker function for dotted_revno_to_revision_id.
291
292
        Subclasses should override this if they wish to
293
        provide a more efficient implementation.
294
        """
295
        if len(revno) == 1:
296
            return self.get_rev_id(revno[0])
297
        revision_id_to_revno = self.get_revision_id_to_revno_map()
3949.2.6 by Ian Clatworthy
review feedback from jam
298
        revision_ids = [revision_id for revision_id, this_revno
299
                        in revision_id_to_revno.iteritems()
300
                        if revno == this_revno]
301
        if len(revision_ids) == 1:
302
            return revision_ids[0]
3949.2.1 by Ian Clatworthy
Branch.dotted_revno_to_revision_id API
303
        else:
304
            revno_str = '.'.join(map(str, revno))
305
            raise errors.NoSuchRevision(self, revno_str)
306
307
    @needs_read_lock
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
308
    def revision_id_to_dotted_revno(self, revision_id):
309
        """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.
310
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
311
        :return: a tuple like (1,) or (400,1,3).
312
        """
3949.2.6 by Ian Clatworthy
review feedback from jam
313
        return self._do_revision_id_to_dotted_revno(revision_id)
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
314
3949.2.6 by Ian Clatworthy
review feedback from jam
315
    def _do_revision_id_to_dotted_revno(self, revision_id):
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
316
        """Worker function for revision_id_to_revno."""
3949.2.4 by Ian Clatworthy
add top level revno cache
317
        # Try the caches if they are loaded
3949.2.6 by Ian Clatworthy
review feedback from jam
318
        result = self._partial_revision_id_to_revno_cache.get(revision_id)
319
        if result is not None:
320
            return result
321
        if self._revision_id_to_revno_cache:
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
322
            result = self._revision_id_to_revno_cache.get(revision_id)
3949.2.6 by Ian Clatworthy
review feedback from jam
323
            if result is None:
324
                raise errors.NoSuchRevision(self, revision_id)
325
        # Try the mainline as it's optimised
326
        try:
327
            revno = self.revision_id_to_revno(revision_id)
328
            return (revno,)
329
        except errors.NoSuchRevision:
330
            # We need to load and use the full revno map after all
331
            result = self.get_revision_id_to_revno_map().get(revision_id)
332
            if result is None:
333
                raise errors.NoSuchRevision(self, revision_id)
3949.2.3 by Ian Clatworthy
add Branch.revision_id_to_dotted_revno()
334
        return result
335
3949.2.7 by Ian Clatworthy
fix accidental needs_read_lock removal
336
    @needs_read_lock
2418.5.12 by John Arbash Meinel
Move functions from BzrBranch to base Branch object.
337
    def get_revision_id_to_revno_map(self):
338
        """Return the revision_id => dotted revno map.
339
340
        This will be regenerated on demand, but will be cached.
341
342
        :return: A dictionary mapping revision_id => dotted revno.
343
            This dictionary should not be modified by the caller.
344
        """
345
        if self._revision_id_to_revno_cache is not None:
346
            mapping = self._revision_id_to_revno_cache
347
        else:
348
            mapping = self._gen_revno_map()
349
            self._cache_revision_id_to_revno(mapping)
350
        # TODO: jam 20070417 Since this is being cached, should we be returning
351
        #       a copy?
352
        # I would rather not, and instead just declare that users should not
353
        # modify the return value.
354
        return mapping
355
356
    def _gen_revno_map(self):
357
        """Create a new mapping from revision ids to dotted revnos.
358
359
        Dotted revnos are generated based on the current tip in the revision
360
        history.
361
        This is the worker function for get_revision_id_to_revno_map, which
362
        just caches the return value.
363
364
        :return: A dictionary mapping revision_id => dotted revno.
365
        """
3949.3.1 by Ian Clatworthy
introduce Branch.merge_sorted_revisions API
366
        revision_id_to_revno = dict((rev_id, revno)
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
367
            for rev_id, depth, revno, end_of_merge
368
             in self.iter_merge_sorted_revisions())
3949.3.1 by Ian Clatworthy
introduce Branch.merge_sorted_revisions API
369
        return revision_id_to_revno
370
371
    @needs_read_lock
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
372
    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()
373
            stop_revision_id=None, stop_rule='exclude', direction='reverse'):
3949.3.2 by Ian Clatworthy
feedback from jam
374
        """Walk the revisions for a branch in merge sorted order.
3949.3.1 by Ian Clatworthy
introduce Branch.merge_sorted_revisions API
375
3949.3.8 by Ian Clatworthy
feedback from poolie
376
        Merge sorted order is the output from a merge-aware,
377
        topological sort, i.e. all parents come before their
378
        children going forward; the opposite for reverse.
379
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
380
        :param start_revision_id: the revision_id to begin walking from.
381
            If None, the branch tip is used.
382
        :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()
383
            after. If None, the rest of history is included.
384
        :param stop_rule: if stop_revision_id is not None, the precise rule
385
            to use for termination:
386
            * 'exclude' - leave the stop revision out of the result (default)
387
            * 'include' - the stop revision is the last item in the result
388
            * 'with-merges' - include the stop revision and all of its
389
              merged revisions in the result
3949.3.3 by Ian Clatworthy
simplify the meaning of forward to be appropriate to this layer
390
        :param direction: either 'reverse' or 'forward':
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
391
            * reverse means return the start_revision_id first, i.e.
392
              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
393
            * forward returns tuples in the opposite order to reverse.
394
              Note in particular that forward does *not* do any intelligent
395
              ordering w.r.t. depth as some clients of this API may like.
3949.3.8 by Ian Clatworthy
feedback from poolie
396
              (If required, that ought to be done at higher layers.)
397
398
        :return: an iterator over (revision_id, depth, revno, end_of_merge)
399
            tuples where:
400
401
            * revision_id: the unique id of the revision
402
            * depth: How many levels of merging deep this node has been
403
              found.
404
            * revno_sequence: This field provides a sequence of
405
              revision numbers for all revisions. The format is:
406
              (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
407
              branch that the revno is on. From left to right the REVNO numbers
408
              are the sequence numbers within that branch of the revision.
409
            * end_of_merge: When True the next node (earlier in history) is
410
              part of a different merge.
3949.3.1 by Ian Clatworthy
introduce Branch.merge_sorted_revisions API
411
        """
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
412
        # Note: depth and revno values are in the context of the branch so
413
        # we need the full graph to get stable numbers, regardless of the
414
        # start_revision_id.
415
        if self._merge_sorted_revisions_cache is None:
416
            last_revision = self.last_revision()
3949.3.6 by Ian Clatworthy
feedback from beuno
417
            graph = self.repository.get_graph()
418
            parent_map = dict(((key, value) for key, value in
419
                     graph.iter_ancestry([last_revision]) if value is not None))
420
            revision_graph = repository._strip_NULL_ghosts(parent_map)
3949.3.7 by Ian Clatworthy
drop seqnum from in-memory cache
421
            revs = tsort.merge_sort(revision_graph, last_revision, None,
422
                generate_revno=True)
423
            # Drop the sequence # before caching
424
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
3949.3.6 by Ian Clatworthy
feedback from beuno
425
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
426
        filtered = self._filter_merge_sorted_revisions(
427
            self._merge_sorted_revisions_cache, start_revision_id,
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
428
            stop_revision_id, stop_rule)
3949.3.2 by Ian Clatworthy
feedback from jam
429
        if direction == 'reverse':
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
430
            return filtered
3949.3.2 by Ian Clatworthy
feedback from jam
431
        if direction == 'forward':
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
432
            return reversed(list(filtered))
3949.3.2 by Ian Clatworthy
feedback from jam
433
        else:
434
            raise ValueError('invalid direction %r' % direction)
2418.5.12 by John Arbash Meinel
Move functions from BzrBranch to base Branch object.
435
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
436
    def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
437
        start_revision_id, stop_revision_id, stop_rule):
3949.3.7 by Ian Clatworthy
drop seqnum from in-memory cache
438
        """Iterate over an inclusive range of sorted revisions."""
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
439
        rev_iter = iter(merge_sorted_revisions)
440
        if start_revision_id is not None:
3949.3.7 by Ian Clatworthy
drop seqnum from in-memory cache
441
            for rev_id, depth, revno, end_of_merge in rev_iter:
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
442
                if rev_id != start_revision_id:
443
                    continue
444
                else:
3936.3.30 by Ian Clatworthy
use iter_merge_sorted_revisions() with stop_range feature
445
                    # The decision to include the start or not
446
                    # depends on the stop_rule if a stop is provided
447
                    rev_iter = chain(
448
                        iter([(rev_id, depth, revno, end_of_merge)]),
449
                        rev_iter)
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
450
                    break
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
451
        if stop_revision_id is None:
452
            for rev_id, depth, revno, end_of_merge in rev_iter:
453
                yield rev_id, depth, revno, end_of_merge
454
        elif stop_rule == 'exclude':
455
            for rev_id, depth, revno, end_of_merge in rev_iter:
456
                if rev_id == stop_revision_id:
457
                    return
458
                yield rev_id, depth, revno, end_of_merge
459
        elif stop_rule == 'include':
460
            for rev_id, depth, revno, end_of_merge in rev_iter:
461
                yield rev_id, depth, revno, end_of_merge
462
                if rev_id == stop_revision_id:
463
                    return
464
        elif stop_rule == 'with-merges':
3960.3.4 by Ian Clatworthy
implement with-merges by checking for left-hand parent, not depth
465
            stop_rev = self.repository.get_revision(stop_revision_id)
466
            if stop_rev.parent_ids:
467
                left_parent = stop_rev.parent_ids[0]
468
            else:
469
                left_parent = _mod_revision.NULL_REVISION
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
470
            for rev_id, depth, revno, end_of_merge in rev_iter:
3960.3.4 by Ian Clatworthy
implement with-merges by checking for left-hand parent, not depth
471
                if rev_id == left_parent:
3960.3.1 by Ian Clatworthy
add stop_rule to Branch.iter_merge_sorted_revisions()
472
                    return
473
                yield rev_id, depth, revno, end_of_merge
474
        else:
475
            raise ValueError('invalid stop_rule %r' % stop_rule)
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
476
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
477
    def leave_lock_in_place(self):
478
        """Tell this branch object not to release the physical lock when this
479
        object is unlocked.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
480
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
481
        If lock_write doesn't return a token, then this method is not supported.
482
        """
483
        self.control_files.leave_in_place()
484
485
    def dont_leave_lock_in_place(self):
486
        """Tell this branch object to release the physical lock when this
487
        object is unlocked, even if it didn't originally acquire it.
488
489
        If lock_write doesn't return a token, then this method is not supported.
490
        """
491
        self.control_files.dont_leave_in_place()
492
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
493
    def bind(self, other):
494
        """Bind the local branch the other branch.
495
496
        :param other: The branch to bind to
497
        :type other: Branch
498
        """
499
        raise errors.UpgradeRequired(self.base)
500
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
501
    def set_reference_info(self, file_id, tree_path, branch_location):
502
        """Set the branch location to use for a tree reference."""
503
        raise errors.UnsupportedOperation(self.set_reference_info, self)
504
505
    def get_reference_info(self, file_id):
506
        """Get the tree_path and branch_location for a tree reference."""
507
        raise errors.UnsupportedOperation(self.get_reference_info, self)
508
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.
509
    @needs_write_lock
510
    def fetch(self, from_branch, last_revision=None, pb=None):
511
        """Copy revisions from from_branch into this branch.
512
513
        :param from_branch: Where to copy from.
514
        :param last_revision: What revision to stop at (None for at the end
515
                              of the branch.
516
        :param pb: An optional progress bar to use.
4065.1.1 by Robert Collins
Change the return value of fetch() to None.
517
        :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.
518
        """
519
        if self.base == from_branch.base:
1558.4.11 by Aaron Bentley
Allow merge against self, make fetching self a noop
520
            return (0, [])
4110.2.5 by Martin Pool
Deprecate passing pbs in to fetch()
521
        if pb is not None:
522
            symbol_versioning.warn(
523
                symbol_versioning.deprecated_in((1, 14, 0))
524
                % "pb parameter to fetch()")
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.
525
        from_branch.lock_read()
526
        try:
527
            if last_revision is None:
2230.3.9 by Aaron Bentley
Fix most fetch tests
528
                last_revision = from_branch.last_revision()
3240.1.7 by Aaron Bentley
Update from review comments
529
                last_revision = _mod_revision.ensure_null(last_revision)
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.
530
            return self.repository.fetch(from_branch.repository,
531
                                         revision_id=last_revision,
4110.2.5 by Martin Pool
Deprecate passing pbs in to fetch()
532
                                         pb=pb)
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.
533
        finally:
534
            from_branch.unlock()
535
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
536
    def get_bound_location(self):
1558.7.6 by Aaron Bentley
Fixed typo (Olaf Conradi)
537
        """Return the URL of the branch we are bound to.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
538
539
        Older format branches cannot bind, please be sure to use a metadir
540
        branch.
541
        """
542
        return None
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
543
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
544
    def get_old_bound_location(self):
545
        """Return the URL of the branch we used to be bound to
546
        """
547
        raise errors.UpgradeRequired(self.base)
548
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
549
    def get_commit_builder(self, parents, config=None, timestamp=None,
550
                           timezone=None, committer=None, revprops=None,
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
551
                           revision_id=None):
552
        """Obtain a CommitBuilder for this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
553
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
554
        :param parents: Revision ids of the parents of the new revision.
555
        :param config: Optional configuration to use.
556
        :param timestamp: Optional timestamp recorded for commit.
557
        :param timezone: Optional timezone for timestamp.
558
        :param committer: Optional committer to set for commit.
559
        :param revprops: Optional dictionary of revision properties.
560
        :param revision_id: Optional revision id.
561
        """
562
563
        if config is None:
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
564
            config = self.get_config()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
565
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
566
        return self.repository.get_commit_builder(self, parents, config,
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
567
            timestamp, timezone, committer, revprops, revision_id)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
568
2810.2.1 by Martin Pool
merge vincent and cleanup
569
    def get_master_branch(self, possible_transports=None):
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
570
        """Return the branch we are bound to.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
571
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
572
        :return: Either a Branch, or None
573
        """
574
        return None
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
575
1770.3.2 by Jelmer Vernooij
Move BzrBranch.get_revision_delta() to Branch.get_revision_delta() as it is generic.
576
    def get_revision_delta(self, revno):
577
        """Return the delta for one revision.
578
579
        The delta is relative to its mainline predecessor, or the
580
        empty tree for revision 1.
581
        """
582
        rh = self.revision_history()
583
        if not (1 <= revno <= len(rh)):
3236.1.2 by Michael Hudson
clean up branch.py imports
584
            raise errors.InvalidRevisionNumber(revno)
1770.3.2 by Jelmer Vernooij
Move BzrBranch.get_revision_delta() to Branch.get_revision_delta() as it is generic.
585
        return self.repository.get_revision_delta(rh[revno-1])
586
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
587
    def get_stacked_on_url(self):
3221.11.2 by Robert Collins
Create basic stackable branch facility.
588
        """Get the URL this branch is stacked against.
589
590
        :raises NotStacked: If the branch is not stacked.
591
        :raises UnstackableBranchFormat: If the branch does not support
592
            stacking.
593
        """
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
594
        raise NotImplementedError(self.get_stacked_on_url)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
595
1185.50.9 by John Arbash Meinel
[bug 3632] Matthieu Moy- bzr cat should default to last revision
596
    def print_file(self, file, revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
597
        """Print `file` to stdout."""
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
598
        raise NotImplementedError(self.print_file)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
599
600
    def set_revision_history(self, rev_history):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
601
        raise NotImplementedError(self.set_revision_history)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
602
3537.3.3 by Martin Pool
Rename Branch.set_stacked_on to set_stacked_on_url
603
    def set_stacked_on_url(self, url):
3221.18.1 by Ian Clatworthy
tweaks by ianc during review
604
        """Set the URL this branch is stacked against.
3221.11.2 by Robert Collins
Create basic stackable branch facility.
605
606
        :raises UnstackableBranchFormat: If the branch does not support
607
            stacking.
608
        :raises UnstackableRepositoryFormat: If the repository does not support
609
            stacking.
610
        """
4226.1.3 by Robert Collins
Lift Branch.set_stacked_on_url up from BzrBranch7.
611
        if not self._format.supports_stacking():
612
            raise errors.UnstackableBranchFormat(self._format, self.base)
613
        self._check_stackable_repo()
614
        if not url:
615
            try:
616
                old_url = self.get_stacked_on_url()
617
            except (errors.NotStacked, errors.UnstackableBranchFormat,
618
                errors.UnstackableRepositoryFormat):
619
                return
620
            url = ''
621
            # repositories don't offer an interface to remove fallback
622
            # repositories today; take the conceptually simpler option and just
623
            # reopen it.
624
            self.repository = self.bzrdir.find_repository()
625
            # for every revision reference the branch has, ensure it is pulled
626
            # in.
627
            source_repository = self._get_fallback_repository(old_url)
628
            for revision_id in chain([self.last_revision()],
629
                self.tags.get_reverse_tag_dict()):
630
                self.repository.fetch(source_repository, revision_id,
631
                    find_ghosts=True)
632
        else:
633
            self._activate_fallback_location(url)
634
        # write this out after the repository is stacked to avoid setting a
635
        # stacked config that doesn't work.
636
        self._set_config_location('stacked_on_location', url)
637
3221.11.2 by Robert Collins
Create basic stackable branch facility.
638
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.
639
    def _set_tags_bytes(self, bytes):
640
        """Mirror method for _get_tags_bytes.
641
642
        :seealso: Branch._get_tags_bytes.
643
        """
4084.2.2 by Robert Collins
Review feedback.
644
        return _run_with_write_locked_target(self, self._transport.put_bytes,
645
            '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.
646
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
647
    def _cache_revision_history(self, rev_history):
648
        """Set the cached revision history to rev_history.
649
650
        The revision_history method will use this cache to avoid regenerating
651
        the revision history.
652
653
        This API is semi-public; it only for use by subclasses, all other code
654
        should consider it to be private.
655
        """
656
        self._revision_history_cache = rev_history
657
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
658
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
659
        """Set the cached revision_id => revno map to revision_id_to_revno.
660
661
        This API is semi-public; it only for use by subclasses, all other code
662
        should consider it to be private.
663
        """
664
        self._revision_id_to_revno_cache = revision_id_to_revno
665
2375.1.6 by Andrew Bennetts
Rename _clear_cached_data to _clear_cached_state.
666
    def _clear_cached_state(self):
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
667
        """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.
668
669
        This means the next call to revision_history will need to call
670
        _gen_revision_history.
671
672
        This API is semi-public; it only for use by subclasses, all other code
673
        should consider it to be private.
674
        """
675
        self._revision_history_cache = None
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
676
        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.
677
        self._last_revision_info_cache = None
3949.3.4 by Ian Clatworthy
jam feedback: start & stop limits; simple caching
678
        self._merge_sorted_revisions_cache = None
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
679
680
    def _gen_revision_history(self):
681
        """Return sequence of revision hashes on to this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
682
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
683
        Unlike revision_history, this method always regenerates or rereads the
684
        revision history, i.e. it does not cache the result, so repeated calls
685
        may be expensive.
686
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
687
        Concrete subclasses should override this instead of revision_history so
688
        that subclasses do not need to deal with caching logic.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
689
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
690
        This API is semi-public; it only for use by subclasses, all other code
691
        should consider it to be private.
692
        """
693
        raise NotImplementedError(self._gen_revision_history)
694
695
    @needs_read_lock
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
696
    def revision_history(self):
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
697
        """Return sequence of revision ids on this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
698
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
699
        This method will cache the revision history for as long as it is safe to
700
        do so.
701
        """
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
702
        if 'evil' in debug.debug_flags:
703
            mutter_callsite(3, "revision_history scales with history.")
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
704
        if self._revision_history_cache is not None:
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
705
            history = self._revision_history_cache
706
        else:
707
            history = self._gen_revision_history()
708
            self._cache_revision_history(history)
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
709
        return list(history)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
710
711
    def revno(self):
712
        """Return current revision number for this branch.
713
714
        That is equivalent to the number of revisions committed to
715
        this branch.
716
        """
3066.1.1 by John Arbash Meinel
Make the default Branch.revno() implementation just be a thunk to last_revision_info.
717
        return self.last_revision_info()[0]
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
718
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
719
    def unbind(self):
720
        """Older format branches cannot bind or unbind."""
721
        raise errors.UpgradeRequired(self.base)
722
2230.3.40 by Aaron Bentley
Rename strict_revision_history to append_revisions_only
723
    def set_append_revisions_only(self, enabled):
724
        """Older format branches are never restricted to append-only"""
2230.3.32 by Aaron Bentley
Implement strict history policy
725
        raise errors.UpgradeRequired(self.base)
726
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
727
    def last_revision(self):
3211.2.1 by Robert Collins
* Creating a new branch no longer tries to read the entire revision-history
728
        """Return last revision id, or NULL_REVISION."""
729
        return self.last_revision_info()[1]
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
730
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.
731
    @needs_read_lock
2249.4.1 by Wouter van Heyst
New Branch.last_revision_info method, this is being done to allow
732
    def last_revision_info(self):
733
        """Return information about the last revision.
734
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.
735
        :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
736
        """
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.
737
        if self._last_revision_info_cache is None:
738
            self._last_revision_info_cache = self._last_revision_info()
739
        return self._last_revision_info_cache
740
741
    def _last_revision_info(self):
2249.4.1 by Wouter van Heyst
New Branch.last_revision_info method, this is being done to allow
742
        rh = self.revision_history()
743
        revno = len(rh)
744
        if revno:
745
            return (revno, rh[-1])
746
        else:
747
            return (0, _mod_revision.NULL_REVISION)
748
3445.2.1 by John Arbash Meinel
Add tests for Branch.missing_revisions and deprecate it.
749
    @deprecated_method(deprecated_in((1, 6, 0)))
1505.1.21 by John Arbash Meinel
Removing changes for bound branch by invading set-revision-history.
750
    def missing_revisions(self, other, stop_revision=None):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
751
        """Return a list of new revisions that would perfectly fit.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
752
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
753
        If self and other have not diverged, return a list of the revisions
754
        present in other, but missing from self.
755
        """
756
        self_history = self.revision_history()
757
        self_len = len(self_history)
1505.1.21 by John Arbash Meinel
Removing changes for bound branch by invading set-revision-history.
758
        other_history = other.revision_history()
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
759
        other_len = len(other_history)
760
        common_index = min(self_len, other_len) -1
761
        if common_index >= 0 and \
762
            self_history[common_index] != other_history[common_index]:
3236.1.2 by Michael Hudson
clean up branch.py imports
763
            raise errors.DivergedBranches(self, other)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
764
765
        if stop_revision is None:
766
            stop_revision = other_len
767
        else:
768
            if stop_revision > other_len:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
769
                raise errors.NoSuchRevision(self, stop_revision)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
770
        return other_history[self_len:stop_revision]
1185.66.1 by Aaron Bentley
Merged from mainline
771
3465.1.1 by Jelmer Vernooij
Move implementation of update_revisions() from BzrBranch to Branch as it only uses publib functions.
772
    @needs_write_lock
3445.1.8 by John Arbash Meinel
Clarity tweaks recommended by Ian
773
    def update_revisions(self, other, stop_revision=None, overwrite=False,
774
                         graph=None):
1505.1.16 by John Arbash Meinel
[merge] robertc's integration, updated tests to check for retcode=3
775
        """Pull in new perfect-fit revisions.
776
777
        :param other: Another Branch to pull from
778
        :param stop_revision: Updated until the given revision
3445.1.8 by John Arbash Meinel
Clarity tweaks recommended by Ian
779
        :param overwrite: Always set the branch pointer, rather than checking
780
            to see if it is a proper descendant.
781
        :param graph: A Graph object that can be used to query history
782
            information. This can be None.
1505.1.16 by John Arbash Meinel
[merge] robertc's integration, updated tests to check for retcode=3
783
        :return: None
784
        """
4000.5.1 by Jelmer Vernooij
Add InterBranch.
785
        return InterBranch.get(other, self).update_revisions(stop_revision,
786
            overwrite, graph)
3465.1.1 by Jelmer Vernooij
Move implementation of update_revisions() from BzrBranch to Branch as it only uses publib functions.
787
4048.2.2 by Jelmer Vernooij
New Branch.import_last_Revision_info() function used to pull revisions into the master branch during commit.
788
    def import_last_revision_info(self, source_repo, revno, revid):
789
        """Set the last revision info, importing from another repo if necessary.
790
4048.2.4 by Jelmer Vernooij
Fix whitespace.
791
        This is used by the bound branch code to upload a revision to
4048.2.2 by Jelmer Vernooij
New Branch.import_last_Revision_info() function used to pull revisions into the master branch during commit.
792
        the master branch first before updating the tip of the local branch.
793
794
        :param source_repo: Source repository to optionally fetch from
795
        :param revno: Revision number of the new tip
796
        :param revid: Revision id of the new tip
797
        """
798
        if not self.repository.has_same_location(source_repo):
799
            self.repository.fetch(source_repo, revision_id=revid)
800
        self.set_last_revision_info(revno, revid)
801
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
802
    def revision_id_to_revno(self, revision_id):
803
        """Given a revision id, return its revno"""
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
804
        if _mod_revision.is_null(revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
805
            return 0
806
        history = self.revision_history()
807
        try:
808
            return history.index(revision_id) + 1
809
        except ValueError:
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
810
            raise errors.NoSuchRevision(self, revision_id)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
811
812
    def get_rev_id(self, revno, history=None):
813
        """Find the revision id of the specified revno."""
814
        if revno == 0:
2598.5.10 by Aaron Bentley
Return NULL_REVISION instead of None for the null revision
815
            return _mod_revision.NULL_REVISION
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
816
        if history is None:
817
            history = self.revision_history()
1948.4.1 by John Arbash Meinel
Update number parsers to raise InvalidRevisionSpec. Update revno: itself so it supports negative numbers
818
        if revno <= 0 or revno > len(history):
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
819
            raise errors.NoSuchRevision(self, revno)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
820
        return history[revno - 1]
821
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
822
    def pull(self, source, overwrite=False, stop_revision=None,
3489.2.4 by Andrew Bennetts
Fix all tests broken by fixing make_branch_and_tree.
823
             possible_transports=None, _override_hook_target=None):
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
824
        """Mirror source into this branch.
825
826
        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.
827
828
        :returns: PullResult instance
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
829
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
830
        raise NotImplementedError(self.pull)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
831
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
832
    def push(self, target, overwrite=False, stop_revision=None):
833
        """Mirror this branch into target.
834
835
        This branch is considered to be 'local', having low latency.
836
        """
837
        raise NotImplementedError(self.push)
838
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
839
    def basis_tree(self):
1852.5.1 by Robert Collins
Deprecate EmptyTree in favour of using Repository.revision_tree.
840
        """Return `Tree` object for last revision."""
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
841
        return self.repository.revision_tree(self.last_revision())
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
842
843
    def get_parent(self):
844
        """Return the parent location of the branch.
845
4031.1.1 by Alexander Belchenko
Parent location is not used as default for push.
846
        This is the default location for pull/missing.  The usual
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
847
        pattern is that the user can override it by specifying a
848
        location.
849
        """
4078.2.1 by Robert Collins
Add a Branch.get_parent remote call for RemoteBranch.
850
        parent = self._get_parent_location()
851
        if parent is None:
852
            return parent
853
        # This is an old-format absolute path to a local branch
854
        # turn it into a url
855
        if parent.startswith('/'):
856
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
857
        try:
858
            return urlutils.join(self.base[:-1], parent)
859
        except errors.InvalidURLJoin, e:
860
            raise errors.InaccessibleParent(parent, self.base)
861
862
    def _get_parent_location(self):
863
        raise NotImplementedError(self._get_parent_location)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
864
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
865
    def _set_config_location(self, name, url, config=None,
866
                             make_relative=False):
867
        if config is None:
868
            config = self.get_config()
869
        if url is None:
870
            url = ''
871
        elif make_relative:
872
            url = urlutils.relative_url(self.base, url)
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
873
        config.set_user_option(name, url, warn_masked=True)
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
874
875
    def _get_config_location(self, name, config=None):
876
        if config is None:
877
            config = self.get_config()
878
        location = config.get_user_option(name)
879
        if location == '':
880
            location = None
881
        return location
882
1804.1.1 by Aaron Bentley
Add support for submit location to bundles
883
    def get_submit_branch(self):
884
        """Return the submit location of the branch.
885
886
        This is the default location for bundle.  The usual
887
        pattern is that the user can override it by specifying a
888
        location.
889
        """
890
        return self.get_config().get_user_option('submit_branch')
891
892
    def set_submit_branch(self, location):
893
        """Return the submit location of the branch.
894
895
        This is the default location for bundle.  The usual
896
        pattern is that the user can override it by specifying a
897
        location.
898
        """
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
899
        self.get_config().set_user_option('submit_branch', location,
900
            warn_masked=True)
1804.1.1 by Aaron Bentley
Add support for submit location to bundles
901
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
902
    def get_public_branch(self):
903
        """Return the public location of the branch.
904
4031.3.1 by Frank Aspell
Fixing various typos
905
        This is used by merge directives.
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
906
        """
907
        return self._get_config_location('public_branch')
908
909
    def set_public_branch(self, location):
910
        """Return the submit location of the branch.
911
912
        This is the default location for bundle.  The usual
913
        pattern is that the user can override it by specifying a
914
        location.
915
        """
916
        self._set_config_location('public_branch', location)
917
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
918
    def get_push_location(self):
919
        """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).
920
        push_loc = self.get_config().get_user_option('push_location')
921
        return push_loc
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
922
923
    def set_push_location(self, location):
924
        """Set a new push location for this branch."""
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
925
        raise NotImplementedError(self.set_push_location)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
926
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.
927
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
928
        """Run the post_change_branch_tip hooks."""
929
        hooks = Branch.hooks['post_change_branch_tip']
930
        if not hooks:
931
            return
932
        new_revno, new_revid = self.last_revision_info()
933
        params = ChangeBranchTipParams(
934
            self, old_revno, new_revno, old_revid, new_revid)
935
        for hook in hooks:
936
            hook(params)
937
938
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
939
        """Run the pre_change_branch_tip hooks."""
940
        hooks = Branch.hooks['pre_change_branch_tip']
941
        if not hooks:
942
            return
943
        old_revno, old_revid = self.last_revision_info()
944
        params = ChangeBranchTipParams(
945
            self, old_revno, new_revno, old_revid, new_revid)
946
        for hook in hooks:
947
            try:
948
                hook(params)
949
            except errors.TipChangeRejected:
950
                raise
951
            except Exception:
952
                exc_info = sys.exc_info()
953
                hook_name = Branch.hooks.get_hook_name(hook)
954
                raise errors.HookFailed(
955
                    'pre_change_branch_tip', hook_name, exc_info)
956
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
957
    def set_parent(self, url):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
958
        raise NotImplementedError(self.set_parent)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
959
1587.1.10 by Robert Collins
update updates working tree and branch together.
960
    @needs_write_lock
961
    def update(self):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
962
        """Synchronise this branch with the master branch if any.
1587.1.10 by Robert Collins
update updates working tree and branch together.
963
964
        :return: None or the last_revision pivoted out during the update.
965
        """
966
        return None
967
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
968
    def check_revno(self, revno):
969
        """\
970
        Check whether a revno corresponds to any revision.
971
        Zero (the NULL revision) is considered valid.
972
        """
973
        if revno != 0:
974
            self.check_real_revno(revno)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
975
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
976
    def check_real_revno(self, revno):
977
        """\
978
        Check whether a revno corresponds to a real revision.
979
        Zero (the NULL revision) is considered invalid
980
        """
981
        if revno < 1 or revno > self.revno():
3236.1.2 by Michael Hudson
clean up branch.py imports
982
            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.
983
984
    @needs_read_lock
4050.1.1 by Robert Collins
Fix race condition with branch hooks during cloning when the new branch is stacked.
985
    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.
986
        """Clone this branch into to_bzrdir preserving all semantic values.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
987
4044.1.1 by Robert Collins
Create Branch.create_clone_on_transport helper method to combine bzr and branch creation for push.
988
        Most API users will want 'create_clone_on_transport', which creates a
989
        new bzrdir and branch on the fly.
990
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.
991
        revision_id: if not None, the revision history in the new branch will
992
                     be truncated to end with revision_id.
993
        """
3650.5.1 by Aaron Bentley
Fix push to use clone all the time.
994
        result = to_bzrdir.create_branch()
4050.1.1 by Robert Collins
Fix race condition with branch hooks during cloning when the new branch is stacked.
995
        if repository_policy is not None:
996
            repository_policy.configure_branch(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.
997
        self.copy_content_into(result, revision_id=revision_id)
998
        return  result
999
1000
    @needs_read_lock
4070.3.1 by Robert Collins
Alter branch sprouting with an alternate fix for stacked branches that does not require multiple copy_content_into and set_parent calls, reducing IO and round trips.
1001
    def sprout(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.
1002
        """Create a new line of development from the branch, into to_bzrdir.
3650.2.1 by Aaron Bentley
Fix sprout to honour cloning format
1003
1004
        to_bzrdir controls the branch format.
1005
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.
1006
        revision_id: if not None, the revision history in the new branch will
1007
                     be truncated to end with revision_id.
1008
        """
3650.2.1 by Aaron Bentley
Fix sprout to honour cloning format
1009
        result = to_bzrdir.create_branch()
4070.3.1 by Robert Collins
Alter branch sprouting with an alternate fix for stacked branches that does not require multiple copy_content_into and set_parent calls, reducing IO and round trips.
1010
        if repository_policy is not None:
1011
            repository_policy.configure_branch(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.
1012
        self.copy_content_into(result, revision_id=revision_id)
1013
        result.set_parent(self.bzrdir.root_transport.base)
1014
        return result
1015
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
1016
    def _synchronize_history(self, destination, revision_id):
2230.3.35 by Aaron Bentley
Add documentation for synchonize_history
1017
        """Synchronize last revision and revision history between branches.
1018
1019
        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.
1020
        BzrBranch6, but works for BzrBranch5, as long as the destination's
1021
        repository contains all the lefthand ancestors of the intended
1022
        last_revision.  If not, set_last_revision_info will fail.
2230.3.35 by Aaron Bentley
Add documentation for synchonize_history
1023
1024
        :param destination: The branch to copy the history into
1025
        :param revision_id: The revision-id to truncate history at.  May
1026
          be None to copy complete history.
1027
        """
3834.3.1 by Andrew Bennetts
Get rid of revision_history() call during copy_content_into.
1028
        source_revno, source_revision_id = self.last_revision_info()
1029
        if revision_id is None:
1030
            revno, revision_id = source_revno, source_revision_id
1031
        elif source_revision_id == revision_id:
1032
            # we know the revno without needing to walk all of history
1033
            revno = source_revno
3650.3.3 by Aaron Bentley
fix sprout
1034
        else:
3834.3.1 by Andrew Bennetts
Get rid of revision_history() call during copy_content_into.
1035
            # To figure out the revno for a random revision, we need to build
1036
            # the revision history, and count its length.
1037
            # We don't care about the order, just how long it is.
1038
            # Alternatively, we could start at the current location, and count
1039
            # backwards. But there is no guarantee that we will find it since
1040
            # it may be a merged revision.
1041
            revno = len(list(self.repository.iter_reverse_revision_history(
1042
                                                                revision_id)))
1043
        destination.set_last_revision_info(revno, revision_id)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1044
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.
1045
    @needs_read_lock
1046
    def copy_content_into(self, destination, revision_id=None):
1047
        """Copy the content of self into destination.
1048
1049
        revision_id: if not None, the revision history in the new branch will
1050
                     be truncated to end with revision_id.
1051
        """
4273.1.8 by Aaron Bentley
Handle references in push, pull, merge.
1052
        self.update_references(destination)
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
1053
        self._synchronize_history(destination, revision_id)
1864.7.2 by John Arbash Meinel
Test that we copy the parent across properly (if it is available)
1054
        try:
1055
            parent = self.get_parent()
1056
        except errors.InaccessibleParent, e:
1057
            mutter('parent was not accessible to copy: %s', e)
1058
        else:
1059
            if parent:
1060
                destination.set_parent(parent)
4032.3.3 by Robert Collins
Use the same logic push does to avoid tags operations when pushing new branches.
1061
        if self._push_should_merge_tags():
1062
            self.tags.merge_to(destination.tags)
4273.1.6 by Aaron Bentley
Ensure references are rebased.
1063
1064
    def update_references(self, target):
4273.1.8 by Aaron Bentley
Handle references in push, pull, merge.
1065
        if not getattr(self._format, 'supports_reference_locations', False):
1066
            return
4273.1.6 by Aaron Bentley
Ensure references are rebased.
1067
        reference_dict = self._get_info_dict()
4273.1.9 by Aaron Bentley
Cleanup
1068
        if len(reference_dict) == 0:
1069
            return
4273.1.6 by Aaron Bentley
Ensure references are rebased.
1070
        old_base = self.base
1071
        new_base = target.base
4273.1.7 by Aaron Bentley
Make update_references do a merge.
1072
        target_reference_dict = target._get_info_dict()
4273.1.6 by Aaron Bentley
Ensure references are rebased.
1073
        for file_id, (tree_path, branch_location) in (
1074
            reference_dict.items()):
1075
            branch_location = urlutils.rebase_url(branch_location,
1076
                                                  old_base, new_base)
4273.1.7 by Aaron Bentley
Make update_references do a merge.
1077
            target_reference_dict.setdefault(
1078
                file_id, (tree_path, branch_location))
4273.1.9 by Aaron Bentley
Cleanup
1079
        target._save_reference_dict(target_reference_dict)
1185.66.1 by Aaron Bentley
Merged from mainline
1080
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1081
    @needs_read_lock
1082
    def check(self):
1083
        """Check consistency of the branch.
1084
1085
        In particular this checks that revisions given in the revision-history
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1086
        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
1087
        present in the repository.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1088
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1089
        Callers will typically also want to check the repository.
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1090
1091
        :return: A BranchCheckResult.
1092
        """
1093
        mainline_parent_id = None
3389.2.1 by John Arbash Meinel
Add code to 'bzr check' to detect when the mainline history is inconsistent.
1094
        last_revno, last_revision_id = self.last_revision_info()
1095
        real_rev_history = list(self.repository.iter_reverse_revision_history(
1096
                                last_revision_id))
1097
        real_rev_history.reverse()
1098
        if len(real_rev_history) != last_revno:
1099
            raise errors.BzrCheckError('revno does not match len(mainline)'
1100
                ' %s != %s' % (last_revno, len(real_rev_history)))
1101
        # TODO: We should probably also check that real_rev_history actually
1102
        #       matches self.revision_history()
1103
        for revision_id in real_rev_history:
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1104
            try:
1105
                revision = self.repository.get_revision(revision_id)
1106
            except errors.NoSuchRevision, e:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1107
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
1108
                            % revision_id)
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1109
            # In general the first entry on the revision history has no parents.
1110
            # But it's not illegal for it to have parents listed; this can happen
1111
            # in imports from Arch when the parents weren't reachable.
1112
            if mainline_parent_id is not None:
1113
                if mainline_parent_id not in revision.parent_ids:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1114
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
1115
                                        "parents of {%s}"
1116
                                        % (mainline_parent_id, revision_id))
1117
            mainline_parent_id = revision_id
1118
        return BranchCheckResult(self)
1119
1910.2.39 by Aaron Bentley
Fix checkout bug
1120
    def _get_checkout_format(self):
1121
        """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.
1122
        Weaves are used if this branch's repository uses weaves.
1910.2.39 by Aaron Bentley
Fix checkout bug
1123
        """
2018.5.89 by Andrew Bennetts
Fix thinko in _get_checkout_format; checkouts for RemoteBranches should be in the default bzrdir/repo format, of course. Thanks Robert.
1124
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1125
            from bzrlib.repofmt import weaverepo
1910.2.39 by Aaron Bentley
Fix checkout bug
1126
            format = bzrdir.BzrDirMetaFormat1()
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1127
            format.repository_format = weaverepo.RepositoryFormat7()
1910.2.39 by Aaron Bentley
Fix checkout bug
1128
        else:
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
1129
            format = self.repository.bzrdir.checkout_metadir()
2370.3.2 by John Arbash Meinel
Use BzrDir.set_branch_format() rather than setting it directly.
1130
            format.set_branch_format(self._format)
1910.2.39 by Aaron Bentley
Fix checkout bug
1131
        return format
1132
4044.1.1 by Robert Collins
Create Branch.create_clone_on_transport helper method to combine bzr and branch creation for push.
1133
    def create_clone_on_transport(self, to_transport, revision_id=None,
1134
        stacked_on=None):
1135
        """Create a clone of this branch and its bzrdir.
1136
1137
        :param to_transport: The transport to clone onto.
1138
        :param revision_id: The revision id to use as tip in the new branch.
1139
            If None the tip is obtained from this branch.
1140
        :param stacked_on: An optional URL to stack the clone on.
1141
        """
4044.1.2 by Robert Collins
Reinstate the TODO comment about bzrdir.clone_on_transport.
1142
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1143
        # clone call. Or something. 20090224 RBC/spiv.
4044.1.1 by Robert Collins
Create Branch.create_clone_on_transport helper method to combine bzr and branch creation for push.
1144
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1145
            revision_id=revision_id, stacked_on=stacked_on)
1146
        return dir_to.open_branch()
1147
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1148
    def create_checkout(self, to_location, revision_id=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1149
                        lightweight=False, accelerator_tree=None,
1150
                        hardlink=False):
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1151
        """Create a checkout of a branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1152
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1153
        :param to_location: The url to produce the checkout at
1154
        :param revision_id: The revision to check out
1551.8.5 by Aaron Bentley
Change name to create_checkout
1155
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1156
        produce a bound branch (heavyweight checkout)
3123.5.17 by Aaron Bentley
Update docs
1157
        :param accelerator_tree: A tree which can be used for retrieving file
1158
            contents more quickly than the revision tree, i.e. a workingtree.
1159
            The revision tree will be used for cases where accelerator_tree's
1160
            content is different.
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1161
        :param hardlink: If true, hard-link files from accelerator_tree,
1162
            where possible.
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1163
        :return: The tree of the created checkout
1164
        """
1910.2.39 by Aaron Bentley
Fix checkout bug
1165
        t = transport.get_transport(to_location)
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
1166
        t.ensure_base()
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1167
        if lightweight:
2100.3.26 by Aaron Bentley
checkout type is maintained for subtrees
1168
            format = self._get_checkout_format()
1169
            checkout = format.initialize_on_transport(t)
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
1170
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1171
        else:
1910.2.39 by Aaron Bentley
Fix checkout bug
1172
            format = self._get_checkout_format()
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1173
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1910.2.39 by Aaron Bentley
Fix checkout bug
1174
                to_location, force_new_tree=False, format=format)
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1175
            checkout = checkout_branch.bzrdir
1176
            checkout_branch.bind(self)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1177
            # 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
1178
            # branch tip correctly, and seed it with history.
1179
            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.
1180
            from_branch=None
1181
        tree = checkout.create_workingtree(revision_id,
3123.5.2 by Aaron Bentley
Allow checkout --files_from
1182
                                           from_branch=from_branch,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1183
                                           accelerator_tree=accelerator_tree,
1184
                                           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.
1185
        basis_tree = tree.basis_tree()
1186
        basis_tree.lock_read()
1187
        try:
1188
            for path, file_id in basis_tree.iter_references():
1189
                reference_parent = self.reference_parent(file_id, path)
1190
                reference_parent.create_checkout(tree.abspath(path),
1191
                    basis_tree.get_reference_revision(file_id, path),
1192
                    lightweight)
1193
        finally:
1194
            basis_tree.unlock()
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
1195
        return tree
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
1196
3389.2.3 by John Arbash Meinel
Add Branch.reconcile() functionality.
1197
    @needs_write_lock
1198
    def reconcile(self, thorough=True):
1199
        """Make sure the data stored in this branch is consistent."""
1200
        from bzrlib.reconcile import BranchReconciler
1201
        reconciler = BranchReconciler(self, thorough=thorough)
1202
        reconciler.reconcile()
1203
        return reconciler
1204
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
1205
    def reference_parent(self, file_id, path, possible_transports=None):
2100.3.29 by Aaron Bentley
Get merge working initially
1206
        """Return the parent branch for a tree-reference file_id
1207
        :param file_id: The file_id of the tree reference
1208
        :param path: The path of the file_id in the tree
1209
        :return: A branch associated with the file_id
1210
        """
1211
        # FIXME should provide multiple branches, based on config
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
1212
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1213
                           possible_transports=possible_transports)
2100.3.23 by Aaron Bentley
Nested checkouts kinda work
1214
2220.2.30 by Martin Pool
split out tag-merging code and add some tests
1215
    def supports_tags(self):
1216
        return self._format.supports_tags()
1217
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.
1218
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1219
                                         other_branch):
3441.5.18 by Andrew Bennetts
Fix some test failures.
1220
        """Ensure that revision_b is a descendant of revision_a.
1221
1222
        This is a helper function for update_revisions.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1223
3441.5.18 by Andrew Bennetts
Fix some test failures.
1224
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1225
        :returns: True if revision_b is a descendant of revision_a.
1226
        """
1227
        relation = self._revision_relations(revision_a, revision_b, graph)
1228
        if relation == 'b_descends_from_a':
1229
            return True
1230
        elif relation == 'diverged':
1231
            raise errors.DivergedBranches(self, other_branch)
1232
        elif relation == 'a_descends_from_b':
1233
            return False
1234
        else:
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
1235
            raise AssertionError("invalid relation: %r" % (relation,))
3441.5.18 by Andrew Bennetts
Fix some test failures.
1236
1237
    def _revision_relations(self, revision_a, revision_b, graph):
1238
        """Determine the relationship between two revisions.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1239
3441.5.18 by Andrew Bennetts
Fix some test failures.
1240
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1241
        """
1242
        heads = graph.heads([revision_a, revision_b])
1243
        if heads == set([revision_b]):
1244
            return 'b_descends_from_a'
1245
        elif heads == set([revision_a, revision_b]):
1246
            # These branches have diverged
1247
            return 'diverged'
1248
        elif heads == set([revision_a]):
1249
            return 'a_descends_from_b'
1250
        else:
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
1251
            raise AssertionError("invalid heads: %r" % (heads,))
3441.5.18 by Andrew Bennetts
Fix some test failures.
1252
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1253
1254
class BranchFormat(object):
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1255
    """An encapsulation of the initialization and open routines for a format.
1256
1257
    Formats provide three things:
1258
     * An initialization routine,
1259
     * a format string,
1260
     * an open routine.
1261
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1262
    Formats are placed in an dict by their format string for reference
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1263
    during branch opening. Its not required that these be instances, they
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1264
    can be classes themselves with class methods - it simply depends on
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1265
    whether state is needed for a given format or not.
1266
1267
    Once a format is deprecated, just deprecate the initialize and open
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1268
    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.
1269
    object will be created every time regardless.
1270
    """
1271
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1272
    _default_format = None
1273
    """The default format used for new branches."""
1274
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1275
    _formats = {}
1276
    """The known formats."""
1277
2363.5.5 by Aaron Bentley
add info.describe_format
1278
    def __eq__(self, other):
1279
        return self.__class__ is other.__class__
1280
1281
    def __ne__(self, other):
1282
        return not (self == other)
1283
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1284
    @classmethod
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1285
    def find_format(klass, a_bzrdir):
1286
        """Return the format for the branch object in a_bzrdir."""
1287
        try:
1288
            transport = a_bzrdir.get_branch_transport(None)
1289
            format_string = transport.get("format").read()
1290
            return klass._formats[format_string]
3236.1.2 by Michael Hudson
clean up branch.py imports
1291
        except errors.NoSuchFile:
1292
            raise errors.NotBranchError(path=transport.base)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1293
        except KeyError:
3246.3.2 by Daniel Watkins
Modified uses of errors.UnknownFormatError.
1294
            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.
1295
1296
    @classmethod
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1297
    def get_default_format(klass):
1298
        """Return the current default format."""
1299
        return klass._default_format
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1300
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
1301
    def get_reference(self, a_bzrdir):
1302
        """Get the target reference of the branch in a_bzrdir.
1303
1304
        format probing must have been completed before calling
1305
        this method - it is assumed that the format of the branch
1306
        in a_bzrdir is correct.
1307
1308
        :param a_bzrdir: The bzrdir to get the branch data from.
1309
        :return: None if the branch is not a reference branch.
1310
        """
1311
        return None
1312
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
1313
    @classmethod
1314
    def set_reference(self, a_bzrdir, to_branch):
1315
        """Set the target reference of the branch in a_bzrdir.
1316
1317
        format probing must have been completed before calling
1318
        this method - it is assumed that the format of the branch
1319
        in a_bzrdir is correct.
1320
1321
        :param a_bzrdir: The bzrdir to set the branch reference for.
1322
        :param to_branch: branch that the checkout is to reference
1323
        """
1324
        raise NotImplementedError(self.set_reference)
1325
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1326
    def get_format_string(self):
1327
        """Return the ASCII format string that identifies this format."""
1328
        raise NotImplementedError(self.get_format_string)
1329
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
1330
    def get_format_description(self):
1331
        """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).
1332
        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
1333
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1334
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1335
                           set_format=True):
1336
        """Initialize a branch in a bzrdir, with specified files
1337
1338
        :param a_bzrdir: The bzrdir to initialize the branch in
1339
        :param utf8_files: The files to create as a list of
1340
            (filename, content) tuples
1341
        :param set_format: If True, set the format with
1342
            self.get_format_string.  (BzrBranch4 has its format set
1343
            elsewhere)
1344
        :return: a branch in this format
1345
        """
1346
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1347
        branch_transport = a_bzrdir.get_branch_transport(self)
1348
        lock_map = {
1349
            'metadir': ('lock', lockdir.LockDir),
1350
            'branch4': ('branch-lock', lockable_files.TransportLock),
1351
        }
1352
        lock_name, lock_class = lock_map[lock_type]
1353
        control_files = lockable_files.LockableFiles(branch_transport,
1354
            lock_name, lock_class)
1355
        control_files.create_lock()
1356
        control_files.lock_write()
1357
        if set_format:
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
1358
            utf8_files += [('format', self.get_format_string())]
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1359
        try:
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
1360
            for (filename, content) in utf8_files:
1361
                branch_transport.put_bytes(
1362
                    filename, content,
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
1363
                    mode=a_bzrdir._get_file_mode())
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1364
        finally:
1365
            control_files.unlock()
1366
        return self.open(a_bzrdir, _found=True)
1367
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1368
    def initialize(self, a_bzrdir):
1369
        """Create a branch of this format in a_bzrdir."""
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
1370
        raise NotImplementedError(self.initialize)
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1371
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.
1372
    def is_supported(self):
1373
        """Is this format supported?
1374
1375
        Supported formats can be initialized and opened.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1376
        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.
1377
        some other features depending on the reason for not being supported.
1378
        """
1379
        return True
1380
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.
1381
    def make_tags(self, branch):
1382
        """Create a tags object for branch.
1383
1384
        This method is on BranchFormat, because BranchFormats are reflected
1385
        over the wire via network_name(), whereas full Branch instances require
1386
        multiple VFS method calls to operate at all.
1387
1388
        The default implementation returns a disabled-tags instance.
1389
1390
        Note that it is normal for branch to be a RemoteBranch when using tags
1391
        on a RemoteBranch.
1392
        """
1393
        return DisabledTags(branch)
1394
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
1395
    def network_name(self):
1396
        """A simple byte string uniquely identifying this format for RPC calls.
1397
1398
        MetaDir branch formats use their disk format string to identify the
1399
        repository over the wire. All in one formats such as bzr < 0.8, and
1400
        foreign formats like svn/git and hg should use some marker which is
1401
        unique and immutable.
1402
        """
1403
        raise NotImplementedError(self.network_name)
1404
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1405
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1406
        """Return the branch object for a_bzrdir
1407
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
1408
        :param a_bzrdir: A BzrDir that contains a branch.
1409
        :param _found: a private parameter, do not use it. It is used to
1410
            indicate if format probing has already be done.
1411
        :param ignore_fallbacks: when set, no fallback branches will be opened
1412
            (if there are any).  Default is to open fallbacks.
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1413
        """
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1414
        raise NotImplementedError(self.open)
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1415
1416
    @classmethod
1417
    def register_format(klass, format):
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
1418
        """Register a metadir format."""
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1419
        klass._formats[format.get_format_string()] = format
4075.2.1 by Robert Collins
Audit and make sure we are registering network_name's as factories, not instances.
1420
        # Metadir formats have a network name of their format string, and get
1421
        # registered as class factories.
1422
        network_format_registry.register(format.get_format_string(), format.__class__)
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1423
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.
1424
    @classmethod
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1425
    def set_default_format(klass, format):
1426
        klass._default_format = format
1427
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1428
    def supports_stacking(self):
1429
        """True if this format records a stacked-on branch."""
1430
        return False
1431
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1432
    @classmethod
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.
1433
    def unregister_format(klass, format):
1434
        del klass._formats[format.get_format_string()]
1435
1553.4.8 by Michael Ellerman
Define __str__ for BranchFormat, just return the format string with the
1436
    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.
1437
        return self.get_format_description().rstrip()
1553.4.8 by Michael Ellerman
Define __str__ for BranchFormat, just return the format string with the
1438
2220.2.10 by Martin Pool
(broken) start moving things to branches
1439
    def supports_tags(self):
1440
        """True if this format supports tags stored in the branch"""
1441
        return False  # by default
1442
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1443
2370.4.1 by Robert Collins
New SmartServer hooks facility. There are two initial hooks documented
1444
class BranchHooks(Hooks):
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1445
    """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
1446
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1447
    e.g. ['set_rh'] Is the list of items to be called when the
1448
    set_revision_history function is invoked.
1449
    """
1450
1451
    def __init__(self):
1452
        """Create the default hooks.
1453
1454
        These are all empty initially, because by default nothing should get
1455
        notified.
1456
        """
2370.4.1 by Robert Collins
New SmartServer hooks facility. There are two initial hooks documented
1457
        Hooks.__init__(self)
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1458
        self.create_hook(HookPoint('set_rh',
1459
            "Invoked whenever the revision history has been set via "
1460
            "set_revision_history. The api signature is (branch, "
1461
            "revision_history), and the branch will be write-locked. "
1462
            "The set_rh hook can be expensive for bzr to trigger, a better "
1463
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1464
        self.create_hook(HookPoint('open',
1465
            "Called with the Branch object that has been opened after a "
1466
            "branch is opened.", (1, 8), None))
1467
        self.create_hook(HookPoint('post_push',
1468
            "Called after a push operation completes. post_push is called "
4053.3.4 by Jelmer Vernooij
Update branch hooks documentation.
1469
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1470
            "bzr client.", (0, 15), None))
1471
        self.create_hook(HookPoint('post_pull',
1472
            "Called after a pull operation completes. post_pull is called "
1473
            "with a bzrlib.branch.PullResult object and only runs in the "
1474
            "bzr client.", (0, 15), None))
1475
        self.create_hook(HookPoint('pre_commit',
1476
            "Called after a commit is calculated but before it is is "
1477
            "completed. pre_commit is called with (local, master, old_revno, "
1478
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1479
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1480
            "tree_delta is a TreeDelta object describing changes from the "
1481
            "basis revision. hooks MUST NOT modify this delta. "
1482
            " future_tree is an in-memory tree obtained from "
1483
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1484
            "tree.", (0,91), None))
1485
        self.create_hook(HookPoint('post_commit',
1486
            "Called in the bzr client after a commit has completed. "
1487
            "post_commit is called with (local, master, old_revno, old_revid, "
1488
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1489
            "commit to a branch.", (0, 15), None))
1490
        self.create_hook(HookPoint('post_uncommit',
1491
            "Called in the bzr client after an uncommit completes. "
1492
            "post_uncommit is called with (local, master, old_revno, "
1493
            "old_revid, new_revno, new_revid) where local is the local branch "
1494
            "or None, master is the target branch, and an empty branch "
4031.3.2 by Matt Nordhoff
Merge bzr.dev, fixing conflicts.
1495
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
1496
        self.create_hook(HookPoint('pre_change_branch_tip',
1497
            "Called in bzr client and server before a change to the tip of a "
1498
            "branch is made. pre_change_branch_tip is called with a "
1499
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1500
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1501
        self.create_hook(HookPoint('post_change_branch_tip',
1502
            "Called in bzr client and server after a change to the tip of a "
1503
            "branch is made. post_change_branch_tip is called with a "
1504
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1505
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1506
        self.create_hook(HookPoint('transform_fallback_location',
1507
            "Called when a stacked branch is activating its fallback "
1508
            "locations. transform_fallback_location is called with (branch, "
1509
            "url), and should return a new url. Returning the same url "
1510
            "allows it to be used as-is, returning a different one can be "
1511
            "used to cause the branch to stack on a closer copy of that "
1512
            "fallback_location. Note that the branch cannot have history "
1513
            "accessing methods called on it during this hook because the "
1514
            "fallback locations have not been activated. When there are "
1515
            "multiple hooks installed for transform_fallback_location, "
1516
            "all are called with the url returned from the previous hook."
1517
            "The order is however undefined.", (1, 9), None))
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1518
1519
1520
# install the default hooks into the Branch class.
1521
Branch.hooks = BranchHooks()
1522
1523
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1524
class ChangeBranchTipParams(object):
1525
    """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()
1526
3331.1.7 by James Henstridge
Make the branch a member of the ChangeBranchTipParams object.
1527
    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()
1528
3331.1.13 by James Henstridge
Use last_revision_info() to retrieve the new revision number and ID.
1529
    :ivar branch: the branch being changed
1530
    :ivar old_revno: revision number before the change
1531
    :ivar new_revno: revision number after the change
1532
    :ivar old_revid: revision id before the change
1533
    :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()
1534
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1535
    The revid fields are strings. The revno fields are integers.
1536
    """
1537
3331.1.7 by James Henstridge
Make the branch a member of the ChangeBranchTipParams object.
1538
    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
1539
        """Create a group of ChangeBranchTip parameters.
1540
3331.1.7 by James Henstridge
Make the branch a member of the ChangeBranchTipParams object.
1541
        :param branch: The branch being changed.
3331.1.5 by James Henstridge
Put revno before revid in method arguments to match last_revision_info()
1542
        :param old_revno: Revision number before the change.
1543
        :param new_revno: Revision number after the change.
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1544
        :param old_revid: Tip revision id before the change.
1545
        :param new_revid: Tip revision id after the change.
1546
        """
3331.1.7 by James Henstridge
Make the branch a member of the ChangeBranchTipParams object.
1547
        self.branch = branch
3331.1.5 by James Henstridge
Put revno before revid in method arguments to match last_revision_info()
1548
        self.old_revno = old_revno
1549
        self.new_revno = new_revno
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1550
        self.old_revid = old_revid
1551
        self.new_revid = new_revid
1552
3517.2.3 by Andrew Bennetts
Better tests for {pre,post}_change_branch_tip hooks.
1553
    def __eq__(self, other):
1554
        return self.__dict__ == other.__dict__
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1555
3517.2.3 by Andrew Bennetts
Better tests for {pre,post}_change_branch_tip hooks.
1556
    def __repr__(self):
1557
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1558
            self.__class__.__name__, self.branch,
3517.2.3 by Andrew Bennetts
Better tests for {pre,post}_change_branch_tip hooks.
1559
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1560
3323.2.1 by Ian Clatworthy
first cut at post_change_branch_tip hook
1561
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1562
class BzrBranchFormat4(BranchFormat):
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1563
    """Bzr branch format 4.
1564
1565
    This format has:
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1566
     - a revision-history file.
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1567
     - a branch-lock lock file [ to be shared with the bzrdir ]
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1568
    """
1569
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
1570
    def get_format_description(self):
1571
        """See BranchFormat.get_format_description()."""
1572
        return "Branch format 4"
1573
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1574
    def initialize(self, a_bzrdir):
1575
        """Create a branch of this format in a_bzrdir."""
1576
        utf8_files = [('revision-history', ''),
1577
                      ('branch-name', ''),
1578
                      ]
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1579
        return self._initialize_helper(a_bzrdir, utf8_files,
1580
                                       lock_type='branch4', set_format=False)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1581
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1582
    def __init__(self):
1583
        super(BzrBranchFormat4, self).__init__()
1584
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1585
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
1586
    def network_name(self):
1587
        """The network name for this format is the control dirs disk label."""
1588
        return self._matchingbzrdir.get_format_string()
1589
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1590
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
1591
        """See BranchFormat.open()."""
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1592
        if not _found:
1593
            # we are being called directly and must probe.
1594
            raise NotImplementedError
1595
        return BzrBranch(_format=self,
1534.5.3 by Robert Collins
Make format 4/5/6 branches share a single LockableFiles instance across wt/branch/repository.
1596
                         _control_files=a_bzrdir._control_files,
1534.6.4 by Robert Collins
Creating or opening a branch will use the repository if the format supports that.
1597
                         a_bzrdir=a_bzrdir,
1598
                         _repository=a_bzrdir.open_repository())
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1599
1553.4.8 by Michael Ellerman
Define __str__ for BranchFormat, just return the format string with the
1600
    def __str__(self):
1601
        return "Bazaar-NG branch format 4"
1602
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1603
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1604
class BranchFormatMetadir(BranchFormat):
1605
    """Common logic for meta-dir based branch formats."""
1606
1607
    def _branch_class(self):
1608
        """What class to instantiate on open calls."""
1609
        raise NotImplementedError(self._branch_class)
1610
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
1611
    def network_name(self):
1612
        """A simple byte string uniquely identifying this format for RPC calls.
1613
1614
        Metadir branch formats use their format string.
1615
        """
1616
        return self.get_format_string()
1617
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1618
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
1619
        """See BranchFormat.open()."""
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1620
        if not _found:
1621
            format = BranchFormat.find_format(a_bzrdir)
3221.13.3 by Ian Clatworthy
Merge bzr.dev r3466
1622
            if format.__class__ != self.__class__:
1623
                raise AssertionError("wrong format %r found for %r" %
1624
                    (format, self))
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1625
        try:
1626
            transport = a_bzrdir.get_branch_transport(None)
1627
            control_files = lockable_files.LockableFiles(transport, 'lock',
1628
                                                         lockdir.LockDir)
1629
            return self._branch_class()(_format=self,
1630
                              _control_files=control_files,
1631
                              a_bzrdir=a_bzrdir,
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1632
                              _repository=a_bzrdir.find_repository(),
1633
                              ignore_fallbacks=ignore_fallbacks)
3221.13.3 by Ian Clatworthy
Merge bzr.dev r3466
1634
        except errors.NoSuchFile:
1635
            raise errors.NotBranchError(path=transport.base)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1636
1637
    def __init__(self):
1638
        super(BranchFormatMetadir, self).__init__()
1639
        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.
1640
        self._matchingbzrdir.set_branch_format(self)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1641
1642
    def supports_tags(self):
1643
        return True
1644
1645
1646
class BzrBranchFormat5(BranchFormatMetadir):
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1647
    """Bzr branch format 5.
1648
1649
    This format has:
1650
     - a revision-history file.
1651
     - a format string
1553.5.71 by Martin Pool
Change branch format 5 to use LockDirs, not transport locks
1652
     - a lock dir guarding the branch itself
1653
     - 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.
1654
     - works with shared repositories.
1553.5.71 by Martin Pool
Change branch format 5 to use LockDirs, not transport locks
1655
1656
    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.
1657
    """
1658
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1659
    def _branch_class(self):
1660
        return BzrBranch5
1661
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1662
    def get_format_string(self):
1663
        """See BranchFormat.get_format_string()."""
1664
        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
1665
1666
    def get_format_description(self):
1667
        """See BranchFormat.get_format_description()."""
1668
        return "Branch format 5"
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1669
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1670
    def initialize(self, a_bzrdir):
1671
        """Create a branch of this format in a_bzrdir."""
1672
        utf8_files = [('revision-history', ''),
1673
                      ('branch-name', ''),
1674
                      ]
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1675
        return self._initialize_helper(a_bzrdir, utf8_files)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1676
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1677
    def supports_tags(self):
1678
        return False
1679
1680
1681
class BzrBranchFormat6(BranchFormatMetadir):
2696.3.1 by Martin Pool
(broken) start switching format to dirstate-tags
1682
    """Branch format with last-revision and tags.
2230.3.12 by Aaron Bentley
Clean up trailing whitespace
1683
2230.3.38 by Aaron Bentley
Update docs per Martin's suggestion
1684
    Unlike previous formats, this has no explicit revision history. Instead,
1685
    this just stores the last-revision, and the left-hand history leading
1686
    up to there is the history.
1687
1688
    This format was introduced in bzr 0.15
2696.3.1 by Martin Pool
(broken) start switching format to dirstate-tags
1689
    and became the default in 0.91.
2230.3.1 by Aaron Bentley
Get branch6 creation working
1690
    """
1691
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1692
    def _branch_class(self):
1693
        return BzrBranch6
1694
2230.3.1 by Aaron Bentley
Get branch6 creation working
1695
    def get_format_string(self):
1696
        """See BranchFormat.get_format_string()."""
2255.2.230 by Robert Collins
Update tree format signatures to mention introducing bzr version.
1697
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2230.3.1 by Aaron Bentley
Get branch6 creation working
1698
1699
    def get_format_description(self):
1700
        """See BranchFormat.get_format_description()."""
1701
        return "Branch format 6"
1702
1703
    def initialize(self, a_bzrdir):
1704
        """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
1705
        utf8_files = [('last-revision', '0 null:\n'),
2220.2.28 by Martin Pool
Integrate tags with Branch6:
1706
                      ('branch.conf', ''),
1707
                      ('tags', ''),
2230.3.1 by Aaron Bentley
Get branch6 creation working
1708
                      ]
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1709
        return self._initialize_helper(a_bzrdir, utf8_files)
2230.3.1 by Aaron Bentley
Get branch6 creation working
1710
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.
1711
    def make_tags(self, branch):
1712
        """See bzrlib.branch.BranchFormat.make_tags()."""
1713
        return BasicTags(branch)
1714
1715
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1716
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
1717
class BzrBranchFormat8(BranchFormatMetadir):
1718
    """Metadir format supporting storing locations of subtree branches."""
1719
1720
    def _branch_class(self):
1721
        return BzrBranch8
1722
1723
    def get_format_string(self):
1724
        """See BranchFormat.get_format_string()."""
1725
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1726
1727
    def get_format_description(self):
1728
        """See BranchFormat.get_format_description()."""
1729
        return "Branch format 8"
1730
1731
    def initialize(self, a_bzrdir):
1732
        """Create a branch of this format in a_bzrdir."""
1733
        utf8_files = [('last-revision', '0 null:\n'),
1734
                      ('branch.conf', ''),
1735
                      ('tags', ''),
1736
                      ('references', '')
1737
                      ]
1738
        return self._initialize_helper(a_bzrdir, utf8_files)
1739
1740
    def __init__(self):
1741
        super(BzrBranchFormat8, self).__init__()
1742
        self._matchingbzrdir.repository_format = \
1743
            RepositoryFormatKnitPack5RichRoot()
1744
1745
    def make_tags(self, branch):
1746
        """See bzrlib.branch.BranchFormat.make_tags()."""
1747
        return BasicTags(branch)
1748
1749
    def supports_stacking(self):
1750
        return True
1751
4273.1.5 by Aaron Bentley
Ensure references are propagated by sprout/clone.
1752
    supports_reference_locations = True
1753
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
1754
1755
class BzrBranchFormat7(BzrBranchFormat8):
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1756
    """Branch format with last-revision, tags, and a stacked location pointer.
1757
1758
    The stacked location pointer is passed down to the repository and requires
1759
    a repository format with supports_external_lookups = True.
1760
3221.13.6 by Ian Clatworthy
update BzrBranch7 format to say 1.6, not 1.3
1761
    This format was introduced in bzr 1.6.
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1762
    """
1763
1764
    def _branch_class(self):
1765
        return BzrBranch7
1766
1767
    def get_format_string(self):
1768
        """See BranchFormat.get_format_string()."""
3221.13.6 by Ian Clatworthy
update BzrBranch7 format to say 1.6, not 1.3
1769
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1770
1771
    def get_format_description(self):
1772
        """See BranchFormat.get_format_description()."""
1773
        return "Branch format 7"
1774
4273.1.5 by Aaron Bentley
Ensure references are propagated by sprout/clone.
1775
    supports_reference_locations = False
1776
2230.3.1 by Aaron Bentley
Get branch6 creation working
1777
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.
1778
class BranchReferenceFormat(BranchFormat):
1779
    """Bzr branch reference format.
1780
1781
    Branch references are used in implementing checkouts, they
1782
    act as an alias to the real branch which is at some other url.
1783
1784
    This format has:
1785
     - A location file
1786
     - a format string
1787
    """
1788
1789
    def get_format_string(self):
1790
        """See BranchFormat.get_format_string()."""
1791
        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
1792
1793
    def get_format_description(self):
1794
        """See BranchFormat.get_format_description()."""
1795
        return "Checkout reference format 1"
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
1796
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
1797
    def get_reference(self, a_bzrdir):
1798
        """See BranchFormat.get_reference()."""
1799
        transport = a_bzrdir.get_branch_transport(None)
1800
        return transport.get('location').read()
1801
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
1802
    def set_reference(self, a_bzrdir, to_branch):
1803
        """See BranchFormat.set_reference()."""
1804
        transport = a_bzrdir.get_branch_transport(None)
1805
        location = transport.put_bytes('location', to_branch.base)
1806
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.
1807
    def initialize(self, a_bzrdir, target_branch=None):
1808
        """Create a branch of this format in a_bzrdir."""
1809
        if target_branch is None:
1810
            # this format does not implement branch itself, thus the implicit
1811
            # creation contract must see it as uninitializable
1812
            raise errors.UninitializableFormat(self)
1813
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1814
        branch_transport = a_bzrdir.get_branch_transport(self)
1955.3.9 by John Arbash Meinel
Find more occurrances of put() and replace with put_file or put_bytes
1815
        branch_transport.put_bytes('location',
1955.3.25 by John Arbash Meinel
apply a FIXME
1816
            target_branch.bzrdir.root_transport.base)
1955.3.9 by John Arbash Meinel
Find more occurrances of put() and replace with put_file or put_bytes
1817
        branch_transport.put_bytes('format', self.get_format_string())
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
1818
        return self.open(
1819
            a_bzrdir, _found=True,
1820
            possible_transports=[target_branch.bzrdir.root_transport])
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.
1821
1822
    def __init__(self):
1823
        super(BranchReferenceFormat, self).__init__()
1824
        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.
1825
        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.
1826
1827
    def _make_reference_clone_function(format, a_branch):
1828
        """Create a clone() routine for a branch dynamically."""
4050.1.3 by Robert Collins
Add missed new parameter for branch reference cloning.
1829
        def clone(to_bzrdir, revision_id=None,
1830
            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.
1831
            """See Branch.clone()."""
1832
            return format.initialize(to_bzrdir, a_branch)
1833
            # cannot obey revision_id limits when cloning a reference ...
1834
            # FIXME RBC 20060210 either nuke revision_id for clone, or
1835
            # emit some sort of warning/error to the caller ?!
1836
        return clone
1837
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
1838
    def open(self, a_bzrdir, _found=False, location=None,
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1839
             possible_transports=None, ignore_fallbacks=False):
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.
1840
        """Return the branch that the branch reference in a_bzrdir points at.
1841
4160.2.12 by Andrew Bennetts
Improve docstrings and remove a line of cruft.
1842
        :param a_bzrdir: A BzrDir that contains a branch.
1843
        :param _found: a private parameter, do not use it. It is used to
1844
            indicate if format probing has already be done.
1845
        :param ignore_fallbacks: when set, no fallback branches will be opened
1846
            (if there are any).  Default is to open fallbacks.
1847
        :param location: The location of the referenced branch.  If
1848
            unspecified, this will be determined from the branch reference in
1849
            a_bzrdir.
1850
        :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.
1851
        """
1852
        if not _found:
1853
            format = BranchFormat.find_format(a_bzrdir)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1854
            if format.__class__ != self.__class__:
1855
                raise AssertionError("wrong format %r found for %r" %
1856
                    (format, self))
2018.6.1 by Robert Collins
Implement a BzrDir.open_branch smart server method for opening a branch without VFS.
1857
        if location is None:
1858
            location = self.get_reference(a_bzrdir)
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
1859
        real_bzrdir = bzrdir.BzrDir.open(
1860
            location, possible_transports=possible_transports)
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1861
        result = real_bzrdir.open_branch(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.
1862
        # this changes the behaviour of result.clone to create a new reference
1863
        # rather than a copy of the content of the branch.
1864
        # I did not use a proxy object because that needs much more extensive
1865
        # testing, and we are only changing one behaviour at the moment.
1866
        # If we decide to alter more behaviours - i.e. the implicit nickname
1867
        # then this should be refactored to introduce a tested proxy branch
1868
        # and a subclass of that for use in overriding clone() and ....
1869
        # - RBC 20060210
1870
        result.clone = self._make_reference_clone_function(result)
1871
        return result
1872
1873
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
1874
network_format_registry = registry.FormatRegistry()
1875
"""Registry of formats indexed by their network name.
1876
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
1877
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.
1878
referring to formats with smart server operations. See
1879
BranchFormat.network_name() for more detail.
1880
"""
1881
1882
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1883
# formats which have no format string are not discoverable
1884
# and not independently creatable, so are not registered.
2696.3.3 by Martin Pool
Start setting the default format to dirstate-tags
1885
__format5 = BzrBranchFormat5()
1886
__format6 = BzrBranchFormat6()
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1887
__format7 = BzrBranchFormat7()
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
1888
__format8 = BzrBranchFormat8()
2696.3.3 by Martin Pool
Start setting the default format to dirstate-tags
1889
BranchFormat.register_format(__format5)
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.
1890
BranchFormat.register_format(BranchReferenceFormat())
2696.3.3 by Martin Pool
Start setting the default format to dirstate-tags
1891
BranchFormat.register_format(__format6)
3221.11.2 by Robert Collins
Create basic stackable branch facility.
1892
BranchFormat.register_format(__format7)
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
1893
BranchFormat.register_format(__format8)
2696.3.3 by Martin Pool
Start setting the default format to dirstate-tags
1894
BranchFormat.set_default_format(__format6)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1895
_legacy_formats = [BzrBranchFormat4(),
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
1896
    ]
1897
network_format_registry.register(
4075.2.1 by Robert Collins
Audit and make sure we are registering network_name's as factories, not instances.
1898
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
4032.3.1 by Robert Collins
Add a BranchFormat.network_name() method as preparation for creating branches via RPC calls.
1899
1534.4.5 by Robert Collins
Turn branch format.open into a factory.
1900
1495.1.5 by Jelmer Vernooij
Rename NativeBranch -> BzrBranch
1901
class BzrBranch(Branch):
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
1902
    """A branch stored in the actual filesystem.
1903
1904
    Note that it's "local" in the context of the filesystem; it doesn't
1905
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1906
    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
1907
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1908
    :ivar _transport: Transport for file operations on this branch's
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
1909
        control files, typically pointing to the .bzr/branch directory.
1910
    :ivar repository: Repository for this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1911
    :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
1912
        containing the .bzr directory.
1 by mbp at sourcefrog
import from baz patch-364
1913
    """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1914
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
1915
    def __init__(self, _format=None,
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1916
                 _control_files=None, a_bzrdir=None, _repository=None,
1917
                 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)
1918
        """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.
1919
        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)
1920
            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.
1921
        else:
1922
            self.bzrdir = a_bzrdir
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
1923
        self._base = self.bzrdir.transport.clone('..').base
3446.1.1 by Martin Pool
merge further LockableFile deprecations
1924
        # XXX: We should be able to just do
1925
        #   self.base = self.bzrdir.root_transport.base
1926
        # but this does not quite work yet -- mbp 20080522
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1927
        self._format = _format
1534.4.28 by Robert Collins
first cut at merge from integration.
1928
        if _control_files is None:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1929
            raise ValueError('BzrBranch _control_files is None')
1534.4.28 by Robert Collins
first cut at merge from integration.
1930
        self.control_files = _control_files
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
1931
        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.
1932
        self.repository = _repository
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
1933
        Branch.__init__(self)
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
1934
1 by mbp at sourcefrog
import from baz patch-364
1935
    def __str__(self):
1185.65.11 by Robert Collins
Disable inheritance for getting at LockableFiles, rather use composition.
1936
        return '%s(%r)' % (self.__class__.__name__, self.base)
1 by mbp at sourcefrog
import from baz patch-364
1937
1938
    __repr__ = __str__
1939
907.1.17 by John Arbash Meinel
Adding a Branch.base property, removing pull_loc()
1940
    def _get_base(self):
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
1941
        """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
1942
        return self._base
907.1.17 by John Arbash Meinel
Adding a Branch.base property, removing pull_loc()
1943
1442.1.5 by Robert Collins
Give branch.base a docstring.
1944
    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,
1945
4226.1.5 by Robert Collins
Reinstate the use of the Branch.get_config_file verb.
1946
    def _get_config(self):
1947
        return TransportConfig(self._transport, 'branch.conf')
1948
1694.2.6 by Martin Pool
[merge] bzr.dev
1949
    def is_locked(self):
1950
        return self.control_files.is_locked()
1951
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).
1952
    def lock_write(self, token=None):
1953
        repo_token = self.repository.lock_write()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1954
        try:
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).
1955
            token = self.control_files.lock_write(token=token)
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1956
        except:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1957
            self.repository.unlock()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1958
            raise
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).
1959
        return token
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
1960
1185.65.3 by Aaron Bentley
Fixed locking-- all tests pass
1961
    def lock_read(self):
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1962
        self.repository.lock_read()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1963
        try:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1964
            self.control_files.lock_read()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1965
        except:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1966
            self.repository.unlock()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1967
            raise
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
1968
1969
    def unlock(self):
1185.65.11 by Robert Collins
Disable inheritance for getting at LockableFiles, rather use composition.
1970
        # TODO: test for failed two phase locks. This is known broken.
1687.1.8 by Robert Collins
Teach Branch about break_lock.
1971
        try:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1972
            self.control_files.unlock()
1687.1.8 by Robert Collins
Teach Branch about break_lock.
1973
        finally:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1974
            self.repository.unlock()
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
1975
        if not self.control_files.is_locked():
1976
            # we just released the lock
2375.1.6 by Andrew Bennetts
Rename _clear_cached_data to _clear_cached_state.
1977
            self._clear_cached_state()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1978
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
1979
    def peek_lock_mode(self):
1980
        if self.control_files._lock_count == 0:
1981
            return None
1982
        else:
1983
            return self.control_files._lock_mode
1984
1694.2.6 by Martin Pool
[merge] bzr.dev
1985
    def get_physical_lock_status(self):
1986
        return self.control_files.get_physical_lock_status()
1987
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1988
    @needs_read_lock
1185.50.9 by John Arbash Meinel
[bug 3632] Matthieu Moy- bzr cat should default to last revision
1989
    def print_file(self, file, revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1990
        """See Branch.print_file."""
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
1991
        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.
1992
2230.3.49 by Aaron Bentley
Fix cache updating
1993
    def _write_revision_history(self, history):
1994
        """Factored out of set_revision_history.
1995
1996
        This performs the actual writing to disk.
1997
        It is intended to be called by BzrBranch5.set_revision_history."""
3407.2.7 by Martin Pool
Deprecate LockableFiles.put_utf8 and put_bytes.
1998
        self._transport.put_bytes(
1999
            'revision-history', '\n'.join(history),
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2000
            mode=self.bzrdir._get_file_mode())
2230.3.49 by Aaron Bentley
Fix cache updating
2001
1442.1.68 by Robert Collins
'bzr pull' now accepts '--clobber'.
2002
    @needs_write_lock
2003
    def set_revision_history(self, rev_history):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
2004
        """See Branch.set_revision_history."""
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
2005
        if 'evil' in debug.debug_flags:
2006
            mutter_callsite(3, "set_revision_history scales with history.")
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2007
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2008
        for rev_id in rev_history:
2009
            check_not_reserved_id(rev_id)
3577.1.2 by Andrew Bennetts
If there are no post_change_branch_tip hooks to run in set_revision_history, don't calculate last_revision_info().
2010
        if Branch.hooks['post_change_branch_tip']:
2011
            # Don't calculate the last_revision_info() if there are no hooks
2012
            # that will use it.
2013
            old_revno, old_revid = self.last_revision_info()
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
2014
        if len(rev_history) == 0:
2015
            revid = _mod_revision.NULL_REVISION
2016
        else:
2017
            revid = rev_history[-1]
2018
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2230.3.49 by Aaron Bentley
Fix cache updating
2019
        self._write_revision_history(rev_history)
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.
2020
        self._clear_cached_state()
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
2021
        self._cache_revision_history(rev_history)
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
2022
        for hook in Branch.hooks['set_rh']:
2023
            hook(self, rev_history)
3577.1.2 by Andrew Bennetts
If there are no post_change_branch_tip hooks to run in set_revision_history, don't calculate last_revision_info().
2024
        if Branch.hooks['post_change_branch_tip']:
2025
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
233 by mbp at sourcefrog
- more output from test.sh
2026
3834.3.2 by Andrew Bennetts
Preserve BzrBranch5's _synchronize_history code without affecting Branch or BzrBranch7; add effort test for RemoteBranch.copy_content_into.
2027
    def _synchronize_history(self, destination, revision_id):
2028
        """Synchronize last revision and revision history between branches.
2029
2030
        This version is most efficient when the destination is also a
2031
        BzrBranch5, but works for BzrBranch6 as long as the revision
2032
        history is the true lefthand parent history, and all of the revisions
2033
        are in the destination's repository.  If not, set_revision_history
2034
        will fail.
2035
2036
        :param destination: The branch to copy the history into
2037
        :param revision_id: The revision-id to truncate history at.  May
2038
          be None to copy complete history.
2039
        """
3904.3.6 by Andrew Bennetts
Skip test for two formats, and fix format 5 by avoiding a full history sync with non-format5 branches.
2040
        if not isinstance(destination._format, BzrBranchFormat5):
2041
            super(BzrBranch, self)._synchronize_history(
2042
                destination, revision_id)
2043
            return
3834.3.2 by Andrew Bennetts
Preserve BzrBranch5's _synchronize_history code without affecting Branch or BzrBranch7; add effort test for RemoteBranch.copy_content_into.
2044
        if revision_id == _mod_revision.NULL_REVISION:
2045
            new_history = []
2046
        else:
2047
            new_history = self.revision_history()
2048
        if revision_id is not None and new_history != []:
2049
            try:
2050
                new_history = new_history[:new_history.index(revision_id) + 1]
2051
            except ValueError:
2052
                rev = self.repository.get_revision(revision_id)
2053
                new_history = rev.get_history(self.repository)[1:]
2054
        destination.set_revision_history(new_history)
2055
2230.3.5 by Aaron Bentley
implement set_last revision and clone
2056
    @needs_write_lock
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2057
    def set_last_revision_info(self, revno, revision_id):
2697.2.4 by Martin Pool
Remove assertions about revno consistency from BzrBranch.set_last_revision_info
2058
        """Set the last revision of this branch.
2059
2060
        The caller is responsible for checking that the revno is correct
2061
        for this revision id.
2062
2063
        It may be possible to set the branch last revision to an id not
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2064
        present in the repository.  However, branches can also be
2697.2.4 by Martin Pool
Remove assertions about revno consistency from BzrBranch.set_last_revision_info
2065
        configured to check constraints on history, in which case this may not
2066
        be permitted.
2067
        """
3331.1.9 by James Henstridge
Call _make_branch_tip_hook_params() after ensure_null()
2068
        revision_id = _mod_revision.ensure_null(revision_id)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
2069
        # this old format stores the full history, but this api doesn't
2070
        # provide it, so we must generate, and might as well check it's
2071
        # correct
2697.2.5 by Martin Pool
Kill off append_revision
2072
        history = self._lefthand_history(revision_id)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
2073
        if len(history) != revno:
2074
            raise AssertionError('%d != %d' % (len(history), revno))
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2075
        self.set_revision_history(history)
2230.3.5 by Aaron Bentley
implement set_last revision and clone
2076
2230.4.1 by Aaron Bentley
Get log as fast branch5
2077
    def _gen_revision_history(self):
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
2078
        history = self._transport.get_bytes('revision-history').split('\n')
2309.4.11 by John Arbash Meinel
Change Branch5._gen_revision_history() to be a bit faster about reading all revisions.
2079
        if history[-1:] == ['']:
2080
            # There shouldn't be a trailing newline, but just in case.
2081
            history.pop()
2230.4.1 by Aaron Bentley
Get log as fast branch5
2082
        return history
2083
2230.3.2 by Aaron Bentley
Get all branch tests passing
2084
    @needs_write_lock
2230.3.12 by Aaron Bentley
Clean up trailing whitespace
2085
    def generate_revision_history(self, revision_id, last_rev=None,
2230.3.2 by Aaron Bentley
Get all branch tests passing
2086
        other_branch=None):
2087
        """Create a new revision history that will finish with revision_id.
2230.3.12 by Aaron Bentley
Clean up trailing whitespace
2088
2230.3.2 by Aaron Bentley
Get all branch tests passing
2089
        :param revision_id: the new tip to use.
2090
        :param last_rev: The previous last_revision. If not None, then this
2091
            must be a ancestory of revision_id, or DivergedBranches is raised.
2092
        :param other_branch: The other branch that DivergedBranches should
2093
            raise with respect to.
2094
        """
2095
        self.set_revision_history(self._lefthand_history(revision_id,
2096
            last_rev, other_branch))
1792.1.1 by Robert Collins
Factor out revision-history synthesis to make it reusable as Branch.generate_revision_history.
2097
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
2098
    def basis_tree(self):
2099
        """See Branch.basis_tree."""
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
2100
        return self.repository.revision_tree(self.last_revision())
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
2101
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
2102
    @needs_write_lock
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2103
    def pull(self, source, overwrite=False, stop_revision=None,
3489.2.4 by Andrew Bennetts
Fix all tests broken by fixing make_branch_and_tree.
2104
             _hook_master=None, run_hooks=True, possible_transports=None,
2105
             _override_hook_target=None):
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2106
        """See Branch.pull.
2107
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2108
        :param _hook_master: Private parameter - set the branch to
3489.2.7 by Andrew Bennetts
Update comments and docstrings, add NEWS entry.
2109
            be supplied as the master to pull hooks.
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2110
        :param run_hooks: Private parameter - if false, this branch
2111
            is being called because it's the master of the primary branch,
2112
            so it should not run its hooks.
3489.2.7 by Andrew Bennetts
Update comments and docstrings, add NEWS entry.
2113
        :param _override_hook_target: Private parameter - set the branch to be
2114
            supplied as the target_branch to pull hooks.
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2115
        """
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2116
        result = PullResult()
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2117
        result.source_branch = source
3489.2.4 by Andrew Bennetts
Fix all tests broken by fixing make_branch_and_tree.
2118
        if _override_hook_target is None:
2119
            result.target_branch = self
2120
        else:
2121
            result.target_branch = _override_hook_target
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
2122
        source.lock_read()
2123
        try:
3445.1.6 by John Arbash Meinel
Start using the 'graph' parameter of update_revisions to bias push and pull checking
2124
            # We assume that during 'pull' the local repository is closer than
2125
            # the remote one.
4273.1.8 by Aaron Bentley
Handle references in push, pull, merge.
2126
            source.update_references(self)
3445.1.6 by John Arbash Meinel
Start using the 'graph' parameter of update_revisions to bias push and pull checking
2127
            graph = self.repository.get_graph(source.repository)
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2128
            result.old_revno, result.old_revid = self.last_revision_info()
3445.1.6 by John Arbash Meinel
Start using the 'graph' parameter of update_revisions to bias push and pull checking
2129
            self.update_revisions(source, stop_revision, overwrite=overwrite,
2130
                                  graph=graph)
2804.3.1 by Lukáš Lalinský
Overwrite conflicting tags by push|pull --overwrite.
2131
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2132
            result.new_revno, result.new_revid = self.last_revision_info()
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
2133
            if _hook_master:
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2134
                result.master_branch = _hook_master
3489.2.4 by Andrew Bennetts
Fix all tests broken by fixing make_branch_and_tree.
2135
                result.local_branch = result.target_branch
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
2136
            else:
3489.2.4 by Andrew Bennetts
Fix all tests broken by fixing make_branch_and_tree.
2137
                result.master_branch = result.target_branch
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2138
                result.local_branch = None
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2139
            if run_hooks:
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2140
                for hook in Branch.hooks['post_pull']:
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2141
                    hook(result)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
2142
        finally:
2143
            source.unlock()
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2144
        return result
1 by mbp at sourcefrog
import from baz patch-364
2145
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2146
    def _get_parent_location(self):
2147
        _locs = ['parent', 'pull', 'x-pull']
2148
        for l in _locs:
2149
            try:
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
2150
                return self._transport.get_bytes(l).strip('\n')
3236.1.2 by Michael Hudson
clean up branch.py imports
2151
            except errors.NoSuchFile:
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2152
                pass
2153
        return None
2154
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
2155
    @needs_read_lock
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2156
    def push(self, target, overwrite=False, stop_revision=None,
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
2157
             _override_hook_source_branch=None):
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2158
        """See Branch.push.
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2159
2160
        This is the basic concrete implementation of push()
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
2161
2162
        :param _override_hook_source_branch: If specified, run
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2163
        the hooks passing this Branch as the source, rather than self.
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
2164
        This is for use of RemoteBranch, where push is delegated to the
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2165
        underlying vfs-based Branch.
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2166
        """
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
2167
        # TODO: Public option to disable running hooks - should be trivial but
2168
        # needs tests.
3758.1.1 by Andrew Bennetts
Fix #230902 by being more careful not to squash a pre-existing exception when calling foo.unlock()
2169
        return _run_with_write_locked_target(
2170
            target, self._push_with_bound_branches, target, overwrite,
2171
            stop_revision,
2172
            _override_hook_source_branch=_override_hook_source_branch)
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2173
2174
    def _push_with_bound_branches(self, target, overwrite,
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
2175
            stop_revision,
2176
            _override_hook_source_branch=None):
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
2177
        """Push from self into target, and into target's master if any.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2178
2179
        This is on the base BzrBranch class even though it doesn't support
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2180
        bound branches because the *target* might be bound.
2181
        """
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
2182
        def _run_hooks():
2183
            if _override_hook_source_branch:
2184
                result.source_branch = _override_hook_source_branch
2185
            for hook in Branch.hooks['post_push']:
2186
                hook(result)
2187
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2188
        bound_location = target.get_bound_location()
2189
        if bound_location and target.base != bound_location:
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
2190
            # there is a master branch.
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
2191
            #
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
2192
            # XXX: Why the second check?  Is it even supported for a branch to
2193
            # be bound to itself? -- mbp 20070507
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2194
            master_branch = target.get_master_branch()
2195
            master_branch.lock_write()
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
2196
            try:
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2197
                # push into the master from this branch.
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
2198
                self._basic_push(master_branch, overwrite, stop_revision)
2199
                # and push into the target branch from this. Note that we push from
2200
                # this branch again, because its considered the highest bandwidth
2201
                # repository.
2202
                result = self._basic_push(target, overwrite, stop_revision)
2203
                result.master_branch = master_branch
2204
                result.local_branch = target
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
2205
                _run_hooks()
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
2206
                return result
2207
            finally:
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2208
                master_branch.unlock()
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
2209
        else:
2210
            # no master branch
2211
            result = self._basic_push(target, overwrite, stop_revision)
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
2212
            # TODO: Why set master_branch and local_branch if there's no
2213
            # binding?  Maybe cleaner to just leave them unset? -- mbp
2214
            # 20070504
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
2215
            result.master_branch = target
2216
            result.local_branch = None
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
2217
            _run_hooks()
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
2218
            return result
2219
2220
    def _basic_push(self, target, overwrite, stop_revision):
2221
        """Basic implementation of push without bound branches or hooks.
2222
2223
        Must be called with self read locked and target write locked.
2224
        """
4053.3.1 by Jelmer Vernooij
Rename PushResult to BranchPushResult.
2225
        result = BranchPushResult()
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2226
        result.source_branch = self
2227
        result.target_branch = target
3441.5.13 by Andrew Bennetts
Remove unnecessary extra lock_write in _basic_push.
2228
        result.old_revno, result.old_revid = target.last_revision_info()
4273.1.8 by Aaron Bentley
Handle references in push, pull, merge.
2229
        self.update_references(target)
3703.3.1 by Andrew Bennetts
Skip unnecessary work in BzrBranch._basic_push.
2230
        if result.old_revid != self.last_revision():
2231
            # We assume that during 'push' this repository is closer than
2232
            # the target.
2233
            graph = self.repository.get_graph(target.repository)
2234
            target.update_revisions(self, stop_revision, overwrite=overwrite,
2235
                                    graph=graph)
3703.3.5 by Andrew Bennetts
Allow subclasses to control if _basic_push can skip tag merging.
2236
        if self._push_should_merge_tags():
3703.3.1 by Andrew Bennetts
Skip unnecessary work in BzrBranch._basic_push.
2237
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
3441.5.13 by Andrew Bennetts
Remove unnecessary extra lock_write in _basic_push.
2238
        result.new_revno, result.new_revid = target.last_revision_info()
2239
        return result
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
2240
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
2241
    def get_stacked_on_url(self):
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2242
        raise errors.UnstackableBranchFormat(self._format, self.base)
2243
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
2244
    def set_push_location(self, location):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
2245
        """See Branch.set_push_location."""
2120.6.4 by James Henstridge
add support for specifying policy when storing options
2246
        self.get_config().set_user_option(
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
2247
            'push_location', location,
2248
            store=_mod_config.STORE_LOCATION_NORECURSE)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
2249
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
2250
    @needs_write_lock
1150 by Martin Pool
- add new Branch.set_parent and tests
2251
    def set_parent(self, url):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
2252
        """See Branch.set_parent."""
1150 by Martin Pool
- add new Branch.set_parent and tests
2253
        # TODO: Maybe delete old location files?
1185.65.29 by Robert Collins
Implement final review suggestions.
2254
        # URLs should never be unicode, even on the local fs,
2255
        # FIXUP this and get_parent in a future branch format bump:
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
2256
        # read and rewrite the file. RBC 20060125
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2257
        if url is not None:
1685.1.71 by Wouter van Heyst
change branch.{get,set}_parent to store a relative path but return full urls
2258
            if isinstance(url, unicode):
3407.2.3 by Martin Pool
Branch and Repository use their own ._transport rather than going through .control_files
2259
                try:
1685.1.71 by Wouter van Heyst
change branch.{get,set}_parent to store a relative path but return full urls
2260
                    url = url.encode('ascii')
2261
                except UnicodeEncodeError:
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
2262
                    raise errors.InvalidURL(url,
1685.1.71 by Wouter van Heyst
change branch.{get,set}_parent to store a relative path but return full urls
2263
                        "Urls must be 7-bit ascii, "
2264
                        "use bzrlib.urlutils.escape")
1685.1.70 by Wouter van Heyst
working on get_parent, set_parent and relative urls, broken
2265
            url = urlutils.relative_url(self.base, url)
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2266
        self._set_parent_location(url)
2267
2268
    def _set_parent_location(self, url):
2269
        if url is None:
3407.2.3 by Martin Pool
Branch and Repository use their own ._transport rather than going through .control_files
2270
            self._transport.delete('parent')
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2271
        else:
3407.2.3 by Martin Pool
Branch and Repository use their own ._transport rather than going through .control_files
2272
            self._transport.put_bytes('parent', url + '\n',
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2273
                mode=self.bzrdir._get_file_mode())
1150 by Martin Pool
- add new Branch.set_parent and tests
2274
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2275
2276
class BzrBranch5(BzrBranch):
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2277
    """A format 5 branch. This supports new features over plain branches.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2278
2279
    It has support for a master_branch which is the data for bound branches.
2280
    """
2281
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
2282
    @needs_write_lock
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2283
    def pull(self, source, overwrite=False, stop_revision=None,
3489.2.4 by Andrew Bennetts
Fix all tests broken by fixing make_branch_and_tree.
2284
             run_hooks=True, possible_transports=None,
2285
             _override_hook_target=None):
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
2286
        """Pull from source into self, updating my master if any.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2287
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2288
        :param run_hooks: Private parameter - if false, this branch
2289
            is being called because it's the master of the primary branch,
2290
            so it should not run its hooks.
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2291
        """
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2292
        bound_location = self.get_bound_location()
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2293
        master_branch = None
2294
        if bound_location and source.base != bound_location:
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2295
            # not pulling from master, so we need to update master.
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
2296
            master_branch = self.get_master_branch(possible_transports)
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2297
            master_branch.lock_write()
2298
        try:
2299
            if master_branch:
2300
                # pull from source into master.
2301
                master_branch.pull(source, overwrite, stop_revision,
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
2302
                    run_hooks=False)
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2303
            return super(BzrBranch5, self).pull(source, overwrite,
2304
                stop_revision, _hook_master=master_branch,
3489.2.4 by Andrew Bennetts
Fix all tests broken by fixing make_branch_and_tree.
2305
                run_hooks=run_hooks,
2306
                _override_hook_target=_override_hook_target)
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
2307
        finally:
2308
            if master_branch:
2309
                master_branch.unlock()
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
2310
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2311
    def get_bound_location(self):
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
2312
        try:
3388.2.1 by Martin Pool
Deprecate LockableFiles.get_utf8
2313
            return self._transport.get_bytes('bound')[:-1]
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2314
        except errors.NoSuchFile:
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2315
            return None
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
2316
2317
    @needs_read_lock
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2318
    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
2319
        """Return the branch we are bound to.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2320
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
2321
        :return: Either a Branch, or None
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2322
1759.2.2 by Jelmer Vernooij
Revert some of my spelling fixes and fix some typos after review by Aaron.
2323
        This could memoise the branch, but if thats done
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2324
        it must be revalidated on each new lock.
1759.2.2 by Jelmer Vernooij
Revert some of my spelling fixes and fix some typos after review by Aaron.
2325
        So for now we just don't memoise it.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2326
        # RBC 20060304 review this decision.
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
2327
        """
2328
        bound_loc = self.get_bound_location()
2329
        if not bound_loc:
2330
            return None
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2331
        try:
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2332
            return Branch.open(bound_loc,
2333
                               possible_transports=possible_transports)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
2334
        except (errors.NotBranchError, errors.ConnectionError), e:
2335
            raise errors.BoundBranchConnectionFailure(
2336
                    self, bound_loc, e)
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
2337
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2338
    @needs_write_lock
2339
    def set_bound_location(self, location):
1505.1.27 by John Arbash Meinel
Adding tests against an sftp branch.
2340
        """Set the target where this branch is bound to.
2341
2342
        :param location: URL to the target branch
2343
        """
1505.1.25 by John Arbash Meinel
Updated pull. Now all paths which call set_revision_history maintain the branch invariant. All tests pass.
2344
        if location:
3446.1.1 by Martin Pool
merge further LockableFile deprecations
2345
            self._transport.put_bytes('bound', location+'\n',
2346
                mode=self.bzrdir._get_file_mode())
1185.64.2 by Goffredo Baroncelli
- implemented some suggestion by Robert Collins
2347
        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.
2348
            try:
3407.2.3 by Martin Pool
Branch and Repository use their own ._transport rather than going through .control_files
2349
                self._transport.delete('bound')
3236.1.2 by Michael Hudson
clean up branch.py imports
2350
            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.
2351
                return False
2352
            return True
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2353
2354
    @needs_write_lock
2355
    def bind(self, other):
1997.1.5 by Robert Collins
``Branch.bind(other_branch)`` no longer takes a write lock on the
2356
        """Bind this branch to the branch other.
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2357
1997.1.5 by Robert Collins
``Branch.bind(other_branch)`` no longer takes a write lock on the
2358
        This does not push or pull data between the branches, though it does
2359
        check for divergence to raise an error when the branches are not
2360
        either the same, or one a prefix of the other. That behaviour may not
2361
        be useful, so that check may be removed in future.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2362
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2363
        :param other: The branch to bind to
2364
        :type other: Branch
1185.64.2 by Goffredo Baroncelli
- implemented some suggestion by Robert Collins
2365
        """
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
2366
        # TODO: jam 20051230 Consider checking if the target is bound
2367
        #       It is debatable whether you should be able to bind to
2368
        #       a branch which is itself bound.
2369
        #       Committing is obviously forbidden,
2370
        #       but binding itself may not be.
2371
        #       Since we *have* to check at commit time, we don't
2372
        #       *need* to check here
1997.1.5 by Robert Collins
``Branch.bind(other_branch)`` no longer takes a write lock on the
2373
2374
        # we want to raise diverged if:
2375
        # last_rev is not in the other_last_rev history, AND
2376
        # other_last_rev is not in our history, and do it without pulling
2377
        # history around
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
2378
        self.set_bound_location(other.base)
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
2379
1505.1.5 by John Arbash Meinel
Added a test for the unbind command.
2380
    @needs_write_lock
2381
    def unbind(self):
2382
        """If bound, unbind"""
1505.1.25 by John Arbash Meinel
Updated pull. Now all paths which call set_revision_history maintain the branch invariant. All tests pass.
2383
        return self.set_bound_location(None)
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
2384
1587.1.10 by Robert Collins
update updates working tree and branch together.
2385
    @needs_write_lock
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2386
    def update(self, possible_transports=None):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2387
        """Synchronise this branch with the master branch if any.
1587.1.10 by Robert Collins
update updates working tree and branch together.
2388
2389
        :return: None or the last_revision that was pivoted out during the
2390
                 update.
2391
        """
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2392
        master = self.get_master_branch(possible_transports)
1587.1.10 by Robert Collins
update updates working tree and branch together.
2393
        if master is not None:
2653.2.4 by Aaron Bentley
Remove get_ancestry usage from branch
2394
            old_tip = _mod_revision.ensure_null(self.last_revision())
1587.1.10 by Robert Collins
update updates working tree and branch together.
2395
            self.pull(master, overwrite=True)
2653.2.4 by Aaron Bentley
Remove get_ancestry usage from branch
2396
            if self.repository.get_graph().is_ancestor(old_tip,
2397
                _mod_revision.ensure_null(self.last_revision())):
1587.1.10 by Robert Collins
update updates working tree and branch together.
2398
                return None
2399
            return old_tip
2400
        return None
2401
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
2402
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2403
class BzrBranch8(BzrBranch5):
2404
    """A branch that stores tree-reference locations."""
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2405
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2406
    def _open_hook(self):
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
2407
        if self._ignore_fallbacks:
2408
            return
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2409
        try:
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
2410
            url = self.get_stacked_on_url()
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2411
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2412
            errors.UnstackableBranchFormat):
2413
            pass
2414
        else:
3770.2.1 by Michael Hudson
test and feature
2415
            for hook in Branch.hooks['transform_fallback_location']:
2416
                url = hook(self, url)
3770.2.3 by Michael Hudson
check for None being returned for a hook
2417
                if url is None:
2418
                    hook_name = Branch.hooks.get_hook_name(hook)
2419
                    raise AssertionError(
2420
                        "'transform_fallback_location' hook %s returned "
2421
                        "None, not a URL." % hook_name)
3221.11.11 by Robert Collins
Ensure opening a stacked branch gives a ready to use repository.
2422
            self._activate_fallback_location(url)
2423
4160.2.8 by Andrew Bennetts
Slightly less messy BzrBranch7.__init__.
2424
    def __init__(self, *args, **kwargs):
2425
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2426
        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.
2427
        self._last_revision_info_cache = None
3298.2.10 by Aaron Bentley
Refactor partial history code
2428
        self._partial_revision_history_cache = []
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.
2429
2430
    def _clear_cached_state(self):
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2431
        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.
2432
        self._last_revision_info_cache = None
3298.2.10 by Aaron Bentley
Refactor partial history code
2433
        self._partial_revision_history_cache = []
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.
2434
3298.2.10 by Aaron Bentley
Refactor partial history code
2435
    def _last_revision_info(self):
3407.2.3 by Martin Pool
Branch and Repository use their own ._transport rather than going through .control_files
2436
        revision_string = self._transport.get_bytes('last-revision')
3298.2.10 by Aaron Bentley
Refactor partial history code
2437
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2438
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2439
        revno = int(revno)
2440
        return revno, revision_id
2441
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2442
    def _write_last_revision_info(self, revno, revision_id):
2230.3.49 by Aaron Bentley
Fix cache updating
2443
        """Simply write out the revision id, with no checks.
2444
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2445
        Use set_last_revision_info to perform this safely.
2230.3.49 by Aaron Bentley
Fix cache updating
2446
2447
        Does not update the revision_history cache.
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2448
        Intended to be called by set_last_revision_info and
2449
        _write_revision_history.
2230.3.49 by Aaron Bentley
Fix cache updating
2450
        """
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
2451
        revision_id = _mod_revision.ensure_null(revision_id)
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2452
        out_string = '%d %s\n' % (revno, revision_id)
3407.2.7 by Martin Pool
Deprecate LockableFiles.put_utf8 and put_bytes.
2453
        self._transport.put_bytes('last-revision', out_string,
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2454
            mode=self.bzrdir._get_file_mode())
2230.3.2 by Aaron Bentley
Get all branch tests passing
2455
2230.3.49 by Aaron Bentley
Fix cache updating
2456
    @needs_write_lock
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2457
    def set_last_revision_info(self, revno, revision_id):
3331.1.9 by James Henstridge
Call _make_branch_tip_hook_params() after ensure_null()
2458
        revision_id = _mod_revision.ensure_null(revision_id)
3331.1.13 by James Henstridge
Use last_revision_info() to retrieve the new revision number and ID.
2459
        old_revno, old_revid = self.last_revision_info()
2230.3.49 by Aaron Bentley
Fix cache updating
2460
        if self._get_append_revisions_only():
2461
            self._check_history_violation(revision_id)
3517.2.1 by Andrew Bennetts
Quick draft of pre_change_branch_tip hook.
2462
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2463
        self._write_last_revision_info(revno, revision_id)
2375.1.6 by Andrew Bennetts
Rename _clear_cached_data to _clear_cached_state.
2464
        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.
2465
        self._last_revision_info_cache = revno, revision_id
3331.1.13 by James Henstridge
Use last_revision_info() to retrieve the new revision number and ID.
2466
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2230.3.49 by Aaron Bentley
Fix cache updating
2467
3834.3.2 by Andrew Bennetts
Preserve BzrBranch5's _synchronize_history code without affecting Branch or BzrBranch7; add effort test for RemoteBranch.copy_content_into.
2468
    def _synchronize_history(self, destination, revision_id):
2469
        """Synchronize last revision and revision history between branches.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2470
3834.3.2 by Andrew Bennetts
Preserve BzrBranch5's _synchronize_history code without affecting Branch or BzrBranch7; add effort test for RemoteBranch.copy_content_into.
2471
        :see: Branch._synchronize_history
2472
        """
2473
        # XXX: The base Branch has a fast implementation of this method based
2474
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2475
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2476
        # but wants the fast implementation, so it calls
2477
        # Branch._synchronize_history directly.
2478
        Branch._synchronize_history(self, destination, revision_id)
2479
2230.3.32 by Aaron Bentley
Implement strict history policy
2480
    def _check_history_violation(self, revision_id):
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
2481
        last_revision = _mod_revision.ensure_null(self.last_revision())
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
2482
        if _mod_revision.is_null(last_revision):
2230.3.32 by Aaron Bentley
Implement strict history policy
2483
            return
2484
        if last_revision not in self._lefthand_history(revision_id):
2230.3.40 by Aaron Bentley
Rename strict_revision_history to append_revisions_only
2485
            raise errors.AppendRevisionsOnlyViolation(self.base)
2230.3.32 by Aaron Bentley
Implement strict history policy
2486
2230.4.1 by Aaron Bentley
Get log as fast branch5
2487
    def _gen_revision_history(self):
2230.3.2 by Aaron Bentley
Get all branch tests passing
2488
        """Generate the revision history from last revision
2489
        """
3495.2.1 by Aaron Bentley
Tolerate ghosts in mainline (#235055)
2490
        last_revno, last_revision = self.last_revision_info()
2491
        self._extend_partial_history(stop_index=last_revno-1)
3298.2.10 by Aaron Bentley
Refactor partial history code
2492
        return list(reversed(self._partial_revision_history_cache))
2493
3298.2.12 by Aaron Bentley
Add Branch6.revision_id_to_revno
2494
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
3298.2.10 by Aaron Bentley
Refactor partial history code
2495
        """Extend the partial history to include a given index
2496
3298.3.1 by Aaron Bentley
Make stop_revision optional for extend_partial_history
2497
        If a stop_index is supplied, stop when that index has been reached.
3298.2.17 by Aaron Bentley
Update from review
2498
        If a stop_revision is supplied, stop when that revision is
2499
        encountered.  Otherwise, stop when the beginning of history is
2500
        reached.
3298.2.10 by Aaron Bentley
Refactor partial history code
2501
3298.2.17 by Aaron Bentley
Update from review
2502
        :param stop_index: The index which should be present.  When it is
2503
            present, history extension will stop.
2504
        :param revision_id: The revision id which should be present.  When
2505
            it is encountered, history extension will stop.
3298.2.10 by Aaron Bentley
Refactor partial history code
2506
        """
2507
        repo = self.repository
2508
        if len(self._partial_revision_history_cache) == 0:
2509
            iterator = repo.iter_reverse_revision_history(self.last_revision())
3060.3.6 by Lukáš Lalinský
Implement partial history cache in BzrBranch6.
2510
        else:
3298.2.10 by Aaron Bentley
Refactor partial history code
2511
            start_revision = self._partial_revision_history_cache[-1]
2512
            iterator = repo.iter_reverse_revision_history(start_revision)
2513
            #skip the last revision in the list
3298.3.3 by Aaron Bentley
Update from review
2514
            next_revision = iterator.next()
3298.2.10 by Aaron Bentley
Refactor partial history code
2515
        for revision_id in iterator:
2516
            self._partial_revision_history_cache.append(revision_id)
3298.2.12 by Aaron Bentley
Add Branch6.revision_id_to_revno
2517
            if (stop_index is not None and
2518
                len(self._partial_revision_history_cache) > stop_index):
2519
                break
2520
            if revision_id == stop_revision:
3298.2.10 by Aaron Bentley
Refactor partial history code
2521
                break
2230.3.2 by Aaron Bentley
Get all branch tests passing
2522
2230.3.49 by Aaron Bentley
Fix cache updating
2523
    def _write_revision_history(self, history):
2524
        """Factored out of set_revision_history.
2525
2526
        This performs the actual writing to disk, with format-specific checks.
2527
        It is intended to be called by BzrBranch5.set_revision_history.
2528
        """
2230.3.2 by Aaron Bentley
Get all branch tests passing
2529
        if len(history) == 0:
2230.3.49 by Aaron Bentley
Fix cache updating
2530
            last_revision = 'null:'
2230.3.2 by Aaron Bentley
Get all branch tests passing
2531
        else:
2230.3.44 by Aaron Bentley
Change asserts to specific errors for left-hand history violations
2532
            if history != self._lefthand_history(history[-1]):
2533
                raise errors.NotLefthandHistory(history)
2230.3.49 by Aaron Bentley
Fix cache updating
2534
            last_revision = history[-1]
2535
        if self._get_append_revisions_only():
2536
            self._check_history_violation(last_revision)
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2537
        self._write_last_revision_info(len(history), last_revision)
2230.3.1 by Aaron Bentley
Get branch6 creation working
2538
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2539
    @needs_write_lock
2540
    def _set_parent_location(self, url):
2541
        """Set the parent branch"""
2542
        self._set_config_location('parent_location', url, make_relative=True)
2230.3.3 by Aaron Bentley
Add more config testing
2543
2544
    @needs_read_lock
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
2545
    def _get_parent_location(self):
2230.3.3 by Aaron Bentley
Add more config testing
2546
        """Set the parent branch"""
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2547
        return self._get_config_location('parent_location')
2230.3.3 by Aaron Bentley
Add more config testing
2548
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2549
    def _get_info_dict(self):
2550
        rio_file = self._transport.get('references')
2551
        try:
2552
            stanzas = rio.read_stanzas(rio_file)
2553
            info_dict = dict((s['file_id'], (s['tree_path'],
2554
                             s['branch_location'])) for s in stanzas)
2555
        finally:
2556
            rio_file.close()
2557
        return info_dict
2558
2559
    def set_reference_info(self, file_id, tree_path, branch_location):
2560
        """Set the branch location to use for a tree reference."""
2561
        info_dict = self._get_info_dict()
2562
        info_dict[file_id] = (tree_path, branch_location)
2563
        if None in (tree_path, branch_location):
2564
            if tree_path is not None:
2565
                raise ValueError('tree_path must be None when branch_location'
2566
                                 ' is None.')
2567
            if branch_location is not None:
2568
                raise ValueError('branch_location must be None when tree_path'
2569
                                 ' is None.')
2570
            del info_dict[file_id]
4273.1.5 by Aaron Bentley
Ensure references are propagated by sprout/clone.
2571
        self._save_reference_dict(info_dict)
2572
2573
    def _save_reference_dict(self, info_dict):
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2574
        s = StringIO()
2575
        writer = rio.RioWriter(s)
2576
        for key, (tree_path, branch_location) in info_dict.iteritems():
2577
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2578
                                branch_location=branch_location)
2579
            writer.write_stanza(stanza)
2580
        self._transport.put_bytes('references', s.getvalue())
2581
2582
    def get_reference_info(self, file_id):
2583
        """Get the tree_path and branch_location for a tree reference."""
2584
        return self._get_info_dict().get(file_id, (None, None))
2585
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
2586
    def reference_parent(self, file_id, path, possible_transports=None):
4273.1.2 by Aaron Bentley
Use reference_info to get reference_parent.
2587
        """Return the parent branch for a tree-reference file_id.
2588
2589
        :param file_id: The file_id of the tree reference
2590
        :param path: The path of the file_id in the tree
2591
        :return: A branch associated with the file_id
2592
        """
2593
        branch_location = self.get_reference_info(file_id)[1]
2594
        if branch_location is None:
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
2595
            return Branch.reference_parent(self, file_id, path,
2596
                                           possible_transports)
2597
        branch_location = urlutils.join(self.base, branch_location)
2598
        return Branch.open(branch_location,
2599
                           possible_transports=possible_transports)
4273.1.2 by Aaron Bentley
Use reference_info to get reference_parent.
2600
2230.3.3 by Aaron Bentley
Add more config testing
2601
    def set_push_location(self, location):
2602
        """See Branch.set_push_location."""
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2603
        self._set_config_location('push_location', location)
2230.3.3 by Aaron Bentley
Add more config testing
2604
2605
    def set_bound_location(self, location):
2606
        """See Branch.set_push_location."""
2230.3.7 by Aaron Bentley
Fix binding return values
2607
        result = None
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2608
        config = self.get_config()
2230.3.6 by Aaron Bentley
work in progress bind stuff
2609
        if location is None:
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2610
            if config.get_user_option('bound') != 'True':
2230.3.7 by Aaron Bentley
Fix binding return values
2611
                return False
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2612
            else:
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
2613
                config.set_user_option('bound', 'False', warn_masked=True)
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2614
                return True
2615
        else:
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2616
            self._set_config_location('bound_location', location,
2617
                                      config=config)
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
2618
            config.set_user_option('bound', 'True', warn_masked=True)
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2619
        return True
2620
2621
    def _get_bound_location(self, bound):
2622
        """Return the bound location in the config file.
2623
2624
        Return None if the bound parameter does not match"""
2625
        config = self.get_config()
2626
        config_bound = (config.get_user_option('bound') == 'True')
2627
        if config_bound != bound:
2628
            return None
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
2629
        return self._get_config_location('bound_location', config=config)
2230.3.3 by Aaron Bentley
Add more config testing
2630
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
2631
    def get_bound_location(self):
2632
        """See Branch.set_push_location."""
2633
        return self._get_bound_location(True)
2634
2635
    def get_old_bound_location(self):
2636
        """See Branch.get_old_bound_location"""
2637
        return self._get_bound_location(False)
2638
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
2639
    def get_stacked_on_url(self):
3691.2.12 by Martin Pool
Add test for coping without Branch.get_stacked_on_url
2640
        # you can always ask for the URL; but you might not be able to use it
2641
        # if the repo can't support stacking.
2642
        ## self._check_stackable_repo()
3221.18.2 by Ian Clatworthy
store stacked-on location in branch.conf
2643
        stacked_url = self._get_config_location('stacked_on_location')
2644
        if stacked_url is None:
3221.11.6 by Robert Collins
Stackable branch fixes.
2645
            raise errors.NotStacked(self)
2646
        return stacked_url
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2647
2230.3.40 by Aaron Bentley
Rename strict_revision_history to append_revisions_only
2648
    def set_append_revisions_only(self, enabled):
2649
        if enabled:
2230.3.32 by Aaron Bentley
Implement strict history policy
2650
            value = 'True'
2651
        else:
2652
            value = 'False'
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
2653
        self.get_config().set_user_option('append_revisions_only', value,
2654
            warn_masked=True)
2230.3.32 by Aaron Bentley
Implement strict history policy
2655
2230.3.40 by Aaron Bentley
Rename strict_revision_history to append_revisions_only
2656
    def _get_append_revisions_only(self):
2657
        value = self.get_config().get_user_option('append_revisions_only')
2658
        return value == 'True'
2230.3.32 by Aaron Bentley
Implement strict history policy
2659
3240.1.2 by Aaron Bentley
Add write lock
2660
    @needs_write_lock
3240.1.1 by Aaron Bentley
Avoid doing Branch._lefthand_history twice
2661
    def generate_revision_history(self, revision_id, last_rev=None,
2662
                                  other_branch=None):
3240.1.6 by Aaron Bentley
Update docs
2663
        """See BzrBranch5.generate_revision_history"""
3240.1.1 by Aaron Bentley
Avoid doing Branch._lefthand_history twice
2664
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2665
        revno = len(history)
2666
        self.set_last_revision_info(revno, revision_id)
2667
3060.3.3 by Lukáš Lalinský
Make RevisionSpec_revid and RevisionSpec_revno not load the whole revision history.
2668
    @needs_read_lock
3060.3.2 by Lukáš Lalinský
Make RevisionSpec_last not load the whole history.
2669
    def get_rev_id(self, revno, history=None):
2670
        """Find the revision id of the specified revno."""
2671
        if revno == 0:
2672
            return _mod_revision.NULL_REVISION
2673
2674
        last_revno, last_revision_id = self.last_revision_info()
2675
        if revno <= 0 or revno > last_revno:
2676
            raise errors.NoSuchRevision(self, revno)
2677
2678
        if history is not None:
3298.3.3 by Aaron Bentley
Update from review
2679
            return history[revno - 1]
3060.3.2 by Lukáš Lalinský
Make RevisionSpec_last not load the whole history.
2680
3298.2.10 by Aaron Bentley
Refactor partial history code
2681
        index = last_revno - revno
3298.3.2 by Aaron Bentley
Catch history mismatch, cleanup
2682
        if len(self._partial_revision_history_cache) <= index:
2683
            self._extend_partial_history(stop_index=index)
3298.2.10 by Aaron Bentley
Refactor partial history code
2684
        if len(self._partial_revision_history_cache) > index:
2685
            return self._partial_revision_history_cache[index]
3060.3.6 by Lukáš Lalinský
Implement partial history cache in BzrBranch6.
2686
        else:
3298.2.10 by Aaron Bentley
Refactor partial history code
2687
            raise errors.NoSuchRevision(self, revno)
3060.3.2 by Lukáš Lalinský
Make RevisionSpec_last not load the whole history.
2688
3298.2.12 by Aaron Bentley
Add Branch6.revision_id_to_revno
2689
    @needs_read_lock
2690
    def revision_id_to_revno(self, revision_id):
2691
        """Given a revision id, return its revno"""
2692
        if _mod_revision.is_null(revision_id):
2693
            return 0
2694
        try:
2695
            index = self._partial_revision_history_cache.index(revision_id)
2696
        except ValueError:
2697
            self._extend_partial_history(stop_revision=revision_id)
2698
            index = len(self._partial_revision_history_cache) - 1
2699
            if self._partial_revision_history_cache[index] != revision_id:
2700
                raise errors.NoSuchRevision(self, revision_id)
2701
        return self.revno() - index
2702
2230.3.34 by Aaron Bentley
cleanup
2703
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2704
class BzrBranch7(BzrBranch8):
2705
    """A branch with support for a fallback repository."""
2706
2707
    def set_reference_info(self, file_id, tree_path, branch_location):
2708
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2709
2710
    def get_reference_info(self, file_id):
2711
        Branch.get_reference_info(self, file_id)
2712
4273.1.4 by Aaron Bentley
Relative reference locations are branch-relative.
2713
    def reference_parent(self, file_id, path, possible_transports=None):
2714
        return Branch.reference_parent(self, file_id, path,
2715
                                       possible_transports)
4273.1.2 by Aaron Bentley
Use reference_info to get reference_parent.
2716
4273.1.1 by Aaron Bentley
Implement branch format for tree references.
2717
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2718
class BzrBranch6(BzrBranch7):
2719
    """See BzrBranchFormat6 for the capabilities of this branch.
2720
3221.18.1 by Ian Clatworthy
tweaks by ianc during review
2721
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2722
    i.e. stacking.
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2723
    """
2724
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
2725
    def get_stacked_on_url(self):
3221.11.2 by Robert Collins
Create basic stackable branch facility.
2726
        raise errors.UnstackableBranchFormat(self._format, self.base)
2727
2728
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2729
######################################################################
2730
# results of operations
2731
2220.2.37 by Martin Pool
Report conflicting tags from push.
2732
2733
class _Result(object):
2734
2735
    def _show_tag_conficts(self, to_file):
2736
        if not getattr(self, 'tag_conflicts', None):
2737
            return
2738
        to_file.write('Conflicting tags:\n')
2739
        for name, value1, value2 in self.tag_conflicts:
2740
            to_file.write('    %s\n' % (name, ))
2741
2742
2743
class PullResult(_Result):
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2744
    """Result of a Branch.pull operation.
2745
2746
    :ivar old_revno: Revision number before pull.
2747
    :ivar new_revno: Revision number after pull.
2748
    :ivar old_revid: Tip revision id before pull.
2749
    :ivar new_revid: Tip revision id after pull.
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
2750
    :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.
2751
    :ivar master_branch: Master branch of the target, or the target if no
2752
        Master
2753
    :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.
2754
    :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.
2755
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2756
    """
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2757
2297.1.3 by Martin Pool
PullResult can pretend to be an int for api compatibility with old .pull()
2758
    def __int__(self):
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
2759
        # DEPRECATED: pull used to return the change in revno
2760
        return self.new_revno - self.old_revno
2761
2220.2.39 by Martin Pool
Pull also merges tags and warns if they conflict
2762
    def report(self, to_file):
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
2763
        if not is_quiet():
2764
            if self.old_revid == self.new_revid:
2765
                to_file.write('No revisions to pull.\n')
2766
            else:
2767
                to_file.write('Now on revision %d.\n' % self.new_revno)
2220.2.39 by Martin Pool
Pull also merges tags and warns if they conflict
2768
        self._show_tag_conficts(to_file)
2769
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
2770
4053.3.1 by Jelmer Vernooij
Rename PushResult to BranchPushResult.
2771
class BranchPushResult(_Result):
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2772
    """Result of a Branch.push operation.
2773
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
2774
    :ivar old_revno: Revision number (eg 10) of the target before push.
2775
    :ivar new_revno: Revision number (eg 12) of the target after push.
2776
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2777
        before the push.
2778
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2779
        after the push.
2780
    :ivar source_branch: Source branch object that the push was from. This is
2781
        read locked, and generally is a local (and thus low latency) branch.
2782
    :ivar master_branch: If target is a bound branch, the master branch of
2783
        target, or target itself. Always write locked.
2784
    :ivar target_branch: The direct Branch where data is being sent (write
2785
        locked).
2786
    :ivar local_branch: If the target is a bound branch this will be the
2787
        target, otherwise it will be None.
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2788
    """
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
2789
2790
    def __int__(self):
2791
        # DEPRECATED: push used to return the change in revno
2297.1.3 by Martin Pool
PullResult can pretend to be an int for api compatibility with old .pull()
2792
        return self.new_revno - self.old_revno
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2793
2220.2.37 by Martin Pool
Report conflicting tags from push.
2794
    def report(self, to_file):
2795
        """Write a human-readable description of the result."""
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
2796
        if self.old_revid == self.new_revid:
3978.2.2 by Jelmer Vernooij
Write status messages during push to stderr rather than stdout.
2797
            note('No new revisions to push.')
2220.2.37 by Martin Pool
Report conflicting tags from push.
2798
        else:
3978.2.2 by Jelmer Vernooij
Write status messages during push to stderr rather than stdout.
2799
            note('Pushed up to revision %d.' % self.new_revno)
2220.2.37 by Martin Pool
Report conflicting tags from push.
2800
        self._show_tag_conficts(to_file)
2801
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2802
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
2803
class BranchCheckResult(object):
2804
    """Results of checking branch consistency.
2805
2806
    :see: Branch.check
2807
    """
2808
2809
    def __init__(self, branch):
2810
        self.branch = branch
2811
2812
    def report_results(self, verbose):
2813
        """Report the check results via trace.note.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2814
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
2815
        :param verbose: Requests more detailed display of what was checked,
2816
            if any.
2817
        """
2818
        note('checked branch %s format %s',
2819
             self.branch.base,
2820
             self.branch._format)
2821
2822
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2823
class Converter5to6(object):
2824
    """Perform an in-place upgrade of format 5 to format 6"""
2825
2826
    def convert(self, branch):
2827
        # Data for 5 and 6 can peacefully coexist.
2828
        format = BzrBranchFormat6()
2829
        new_branch = format.open(branch.bzrdir, _found=True)
2830
2831
        # 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.
2832
        new_branch._write_last_revision_info(*branch.last_revision_info())
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2833
        new_branch.set_parent(branch.get_parent())
2834
        new_branch.set_bound_location(branch.get_bound_location())
2835
        new_branch.set_push_location(branch.get_push_location())
2836
2220.2.43 by Martin Pool
Should clear tag file when upgrading format 5 to 6 to prevent warning
2837
        # New branch has no tags by default
2838
        new_branch.tags._set_tag_dict({})
2839
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2840
        # Copying done; now update target format
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2841
        new_branch._transport.put_bytes('format',
2842
            format.get_format_string(),
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2843
            mode=new_branch.bzrdir._get_file_mode())
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2844
2845
        # Clean up old files
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
2846
        new_branch._transport.delete('revision-history')
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2847
        try:
2848
            branch.set_parent(None)
3236.1.2 by Michael Hudson
clean up branch.py imports
2849
        except errors.NoSuchFile:
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2850
            pass
2851
        branch.set_bound_location(None)
3221.11.4 by Robert Collins
Add a converter for format 7 branches.
2852
2853
2854
class Converter6to7(object):
2855
    """Perform an in-place upgrade of format 6 to format 7"""
2856
2857
    def convert(self, branch):
3221.11.5 by Robert Collins
Correctly handle multi-step branch upgrades.
2858
        format = BzrBranchFormat7()
3221.18.2 by Ian Clatworthy
store stacked-on location in branch.conf
2859
        branch._set_config_location('stacked_on_location', '')
3221.11.4 by Robert Collins
Add a converter for format 7 branches.
2860
        # update target format
3221.13.5 by Ian Clatworthy
fix LockableFiles deprecations
2861
        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()
2862
2863
2864
2865
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2866
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2867
    duration.
2868
2869
    _run_with_write_locked_target will attempt to release the lock it acquires.
2870
2871
    If an exception is raised by callable, then that exception *will* be
2872
    propagated, even if the unlock attempt raises its own error.  Thus
2873
    _run_with_write_locked_target should be preferred to simply doing::
2874
2875
        target.lock_write()
2876
        try:
2877
            return callable(*args, **kwargs)
2878
        finally:
2879
            target.unlock()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2880
3758.1.1 by Andrew Bennetts
Fix #230902 by being more careful not to squash a pre-existing exception when calling foo.unlock()
2881
    """
2882
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
2883
    # should share code?
2884
    target.lock_write()
2885
    try:
2886
        result = callable(*args, **kwargs)
2887
    except:
2888
        exc_info = sys.exc_info()
2889
        try:
2890
            target.unlock()
2891
        finally:
2892
            raise exc_info[0], exc_info[1], exc_info[2]
2893
    else:
2894
        target.unlock()
2895
        return result
3978.3.1 by Jelmer Vernooij
Add InterBranchBzrDir class.
2896
2897
4000.5.1 by Jelmer Vernooij
Add InterBranch.
2898
class InterBranch(InterObject):
2899
    """This class represents operations taking place between two branches.
2900
2901
    Its instances have methods like pull() and push() and contain
2902
    references to the source and target repositories these operations
2903
    can be carried out on.
2904
    """
2905
2906
    _optimisers = []
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
2907
    """The available optimised InterBranch types."""
2908
2909
    @staticmethod
2910
    def _get_branch_formats_to_test():
2911
        """Return a tuple with the Branch formats to use when testing."""
2912
        raise NotImplementedError(self._get_branch_formats_to_test)
2913
2914
    def update_revisions(self, stop_revision=None, overwrite=False,
2915
                         graph=None):
2916
        """Pull in new perfect-fit revisions.
2917
2918
        :param stop_revision: Updated until the given revision
2919
        :param overwrite: Always set the branch pointer, rather than checking
2920
            to see if it is a proper descendant.
2921
        :param graph: A Graph object that can be used to query history
2922
            information. This can be None.
2923
        :return: None
2924
        """
2925
        raise NotImplementedError(self.update_revisions)
2926
2927
2928
class GenericInterBranch(InterBranch):
2929
    """InterBranch implementation that uses public Branch functions.
4000.5.1 by Jelmer Vernooij
Add InterBranch.
2930
    """
2931
4000.5.3 by Jelmer Vernooij
Add tests for InterBranch.
2932
    @staticmethod
4000.5.5 by Jelmer Vernooij
Allow InterBranch implementations to set different from and to Branch formats for testing.
2933
    def _get_branch_formats_to_test():
2934
        return BranchFormat._default_format, BranchFormat._default_format
4000.5.3 by Jelmer Vernooij
Add tests for InterBranch.
2935
4000.5.1 by Jelmer Vernooij
Add InterBranch.
2936
    def update_revisions(self, stop_revision=None, overwrite=False,
2937
        graph=None):
2938
        """See InterBranch.update_revisions()."""
2939
        self.source.lock_read()
2940
        try:
2941
            other_revno, other_last_revision = self.source.last_revision_info()
2942
            stop_revno = None # unknown
2943
            if stop_revision is None:
2944
                stop_revision = other_last_revision
2945
                if _mod_revision.is_null(stop_revision):
2946
                    # if there are no commits, we're done.
2947
                    return
2948
                stop_revno = other_revno
2949
2950
            # what's the current last revision, before we fetch [and change it
2951
            # possibly]
2952
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
2953
            # we fetch here so that we don't process data twice in the common
2954
            # case of having something to pull, and so that the check for
2955
            # already merged can operate on the just fetched graph, which will
2956
            # be cached in memory.
2957
            self.target.fetch(self.source, stop_revision)
2958
            # Check to see if one is an ancestor of the other
2959
            if not overwrite:
2960
                if graph is None:
2961
                    graph = self.target.repository.get_graph()
2962
                if self.target._check_if_descendant_or_diverged(
2963
                        stop_revision, last_rev, graph, self.source):
2964
                    # stop_revision is a descendant of last_rev, but we aren't
2965
                    # overwriting, so we're done.
2966
                    return
2967
            if stop_revno is None:
2968
                if graph is None:
2969
                    graph = self.target.repository.get_graph()
2970
                this_revno, this_last_revision = \
2971
                        self.target.last_revision_info()
2972
                stop_revno = graph.find_distance_to_null(stop_revision,
2973
                                [(other_last_revision, other_revno),
2974
                                 (this_last_revision, this_revno)])
2975
            self.target.set_last_revision_info(stop_revno, stop_revision)
2976
        finally:
2977
            self.source.unlock()
2978
2979
    @classmethod
2980
    def is_compatible(self, source, target):
2981
        # GenericBranch uses the public API, so always compatible
2982
        return True
2983
2984
2985
InterBranch.register_optimiser(GenericInterBranch)