/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
2220.2.3 by Martin Pool
Add tag: revision namespace.
1
# Copyright (C) 2005, 2006, 2007 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
1551.8.4 by Aaron Bentley
Tweak import style
20
from bzrlib import (
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
21
        bzrdir,
22
        cache_utf8,
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
23
        config as _mod_config,
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
24
        debug,
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
25
        errors,
26
        lockdir,
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
27
        lockable_files,
1996.3.12 by John Arbash Meinel
Change how 'revision' is imported to avoid problems later
28
        revision as _mod_revision,
1911.2.9 by John Arbash Meinel
Fix accidental import removal
29
        transport,
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
30
        tsort,
1551.8.4 by Aaron Bentley
Tweak import style
31
        ui,
1911.2.7 by John Arbash Meinel
[merge] bzr.dev 1924
32
        urlutils,
1551.8.4 by Aaron Bentley
Tweak import style
33
        )
3236.1.2 by Michael Hudson
clean up branch.py imports
34
from bzrlib.config import BranchConfig
2220.2.11 by mbp at sourcefrog
Get tag tests working again, stored in the Branch
35
from bzrlib.tag import (
2220.2.20 by Martin Pool
Tag methods now available through Branch.tags.add_tag, etc
36
    BasicTags,
37
    DisabledTags,
2220.2.11 by mbp at sourcefrog
Get tag tests working again, stored in the Branch
38
    )
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
39
""")
40
1534.4.28 by Robert Collins
first cut at merge from integration.
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
2370.4.1 by Robert Collins
New SmartServer hooks facility. There are two initial hooks documented
42
from bzrlib.hooks import Hooks
3236.1.2 by Michael Hudson
clean up branch.py imports
43
from bzrlib.symbol_versioning import (deprecated_method,
44
                                      zero_sixteen,
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
45
                                      )
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
46
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
1104 by Martin Pool
- Add a simple UIFactory
47
1094 by Martin Pool
- merge aaron's merge improvements 999..1008
48
1186 by Martin Pool
- start implementing v5 format; Branch refuses to operate on old branches
49
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
50
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.
51
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:
52
53
54
# TODO: Maybe include checks for common corruption of newlines, etc?
1 by mbp at sourcefrog
import from baz patch-364
55
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
56
# TODO: Some operations like log might retrieve the same revisions
57
# repeatedly to calculate deltas.  We could perhaps have a weakref
1223 by Martin Pool
- store inventories in weave
58
# cache in memory to make this faster.  In general anything can be
1185.65.29 by Robert Collins
Implement final review suggestions.
59
# cached in memory between lock and unlock operations. .. nb thats
60
# what the transaction identity map provides
416 by Martin Pool
- bzr log and bzr root now accept an http URL
61
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
62
1 by mbp at sourcefrog
import from baz patch-364
63
######################################################################
64
# branch objects
65
558 by Martin Pool
- All top-level classes inherit from object
66
class Branch(object):
1 by mbp at sourcefrog
import from baz patch-364
67
    """Branch holding a history of revisions.
68
343 by Martin Pool
doc
69
    base
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
70
        Base directory/url of the branch.
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
71
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.
72
    hooks: An instance of BranchHooks.
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
73
    """
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
74
    # this is really an instance variable - FIXME move it there
75
    # - RBC 20060112
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
76
    base = None
77
2220.2.10 by Martin Pool
(broken) start moving things to branches
78
    # override this to set the strategy for storing tags
2220.2.20 by Martin Pool
Tag methods now available through Branch.tags.add_tag, etc
79
    def _make_tags(self):
80
        return DisabledTags(self)
2220.2.10 by Martin Pool
(broken) start moving things to branches
81
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
82
    def __init__(self, *ignored, **ignored_too):
2220.2.20 by Martin Pool
Tag methods now available through Branch.tags.add_tag, etc
83
        self.tags = self._make_tags()
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
84
        self._revision_history_cache = None
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
85
        self._revision_id_to_revno_cache = None
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
86
1687.1.8 by Robert Collins
Teach Branch about break_lock.
87
    def break_lock(self):
88
        """Break a lock if one is present from another instance.
89
90
        Uses the ui factory to ask for confirmation if the lock may be from
91
        an active process.
92
93
        This will probe the repository for its lock as well.
94
        """
95
        self.control_files.break_lock()
96
        self.repository.break_lock()
1687.1.10 by Robert Collins
Branch.break_lock should handle bound branches too
97
        master = self.get_master_branch()
98
        if master is not None:
99
            master.break_lock()
1687.1.8 by Robert Collins
Teach Branch about break_lock.
100
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
101
    @staticmethod
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
102
    def open(base, _unsupported=False, possible_transports=None):
1815.1.1 by Jelmer Vernooij
Fix copy-pasted comment.
103
        """Open the branch rooted at base.
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
104
1815.1.1 by Jelmer Vernooij
Fix copy-pasted comment.
105
        For instance, if the branch is at URL/.bzr/branch,
106
        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.
107
        """
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
108
        control = bzrdir.BzrDir.open(base, _unsupported,
109
                                     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.
110
        return control.open_branch(_unsupported)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
111
112
    @staticmethod
2485.8.35 by Vincent Ladeuil
Fix pull multiple connections.
113
    def open_from_transport(transport, _unsupported=False):
114
        """Open the branch rooted at transport"""
115
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
116
        return control.open_branch(_unsupported)
117
118
    @staticmethod
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
119
    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
120
        """Open an existing branch which contains url.
121
        
122
        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
123
124
        Basically we keep looking up until we find the control directory or
125
        run into the root.  If there isn't one, raises NotBranchError.
1534.4.22 by Robert Collins
update TODOs and move abstract methods that were misplaced on BzrBranchFormat5 to Branch.
126
        If there is one and it is either an unrecognised format or an unsupported 
127
        format, UnknownFormatError or UnsupportedFormatError are raised.
1442.1.64 by Robert Collins
Branch.open_containing now returns a tuple (Branch, relative-path).
128
        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.
129
        """
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
130
        control, relpath = bzrdir.BzrDir.open_containing(url,
131
                                                         possible_transports)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
132
        return control.open_branch(), relpath
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
133
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
134
    def get_config(self):
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
135
        return BranchConfig(self)
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
136
1185.35.11 by Aaron Bentley
Added support for branch nicks
137
    def _get_nick(self):
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
138
        return self.get_config().get_nickname()
1185.35.11 by Aaron Bentley
Added support for branch nicks
139
140
    def _set_nick(self, nick):
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
141
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
1185.35.11 by Aaron Bentley
Added support for branch nicks
142
143
    nick = property(_get_nick, _set_nick)
1694.2.6 by Martin Pool
[merge] bzr.dev
144
145
    def is_locked(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
146
        raise NotImplementedError(self.is_locked)
1694.2.6 by Martin Pool
[merge] bzr.dev
147
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
148
    def lock_write(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
149
        raise NotImplementedError(self.lock_write)
1694.2.6 by Martin Pool
[merge] bzr.dev
150
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
151
    def lock_read(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
152
        raise NotImplementedError(self.lock_read)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
153
154
    def unlock(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
155
        raise NotImplementedError(self.unlock)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
156
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
157
    def peek_lock_mode(self):
158
        """Return lock mode for the Branch: 'r', 'w' or None"""
1185.70.6 by Martin Pool
review fixups from John
159
        raise NotImplementedError(self.peek_lock_mode)
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
160
1694.2.6 by Martin Pool
[merge] bzr.dev
161
    def get_physical_lock_status(self):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
162
        raise NotImplementedError(self.get_physical_lock_status)
1694.2.6 by Martin Pool
[merge] bzr.dev
163
2418.5.12 by John Arbash Meinel
Move functions from BzrBranch to base Branch object.
164
    @needs_read_lock
165
    def get_revision_id_to_revno_map(self):
166
        """Return the revision_id => dotted revno map.
167
168
        This will be regenerated on demand, but will be cached.
169
170
        :return: A dictionary mapping revision_id => dotted revno.
171
            This dictionary should not be modified by the caller.
172
        """
173
        if self._revision_id_to_revno_cache is not None:
174
            mapping = self._revision_id_to_revno_cache
175
        else:
176
            mapping = self._gen_revno_map()
177
            self._cache_revision_id_to_revno(mapping)
178
        # TODO: jam 20070417 Since this is being cached, should we be returning
179
        #       a copy?
180
        # I would rather not, and instead just declare that users should not
181
        # modify the return value.
182
        return mapping
183
184
    def _gen_revno_map(self):
185
        """Create a new mapping from revision ids to dotted revnos.
186
187
        Dotted revnos are generated based on the current tip in the revision
188
        history.
189
        This is the worker function for get_revision_id_to_revno_map, which
190
        just caches the return value.
191
192
        :return: A dictionary mapping revision_id => dotted revno.
193
        """
194
        last_revision = self.last_revision()
195
        revision_graph = self.repository.get_revision_graph(last_revision)
196
        merge_sorted_revisions = tsort.merge_sort(
197
            revision_graph,
198
            last_revision,
199
            None,
200
            generate_revno=True)
201
        revision_id_to_revno = dict((rev_id, revno)
202
                                    for seq_num, rev_id, depth, revno, end_of_merge
203
                                     in merge_sorted_revisions)
204
        return revision_id_to_revno
205
2018.5.79 by Andrew Bennetts
Implement RemoteBranch.lock_write/unlock as smart operations.
206
    def leave_lock_in_place(self):
207
        """Tell this branch object not to release the physical lock when this
208
        object is unlocked.
209
        
210
        If lock_write doesn't return a token, then this method is not supported.
211
        """
212
        self.control_files.leave_in_place()
213
214
    def dont_leave_lock_in_place(self):
215
        """Tell this branch object to release the physical lock when this
216
        object is unlocked, even if it didn't originally acquire it.
217
218
        If lock_write doesn't return a token, then this method is not supported.
219
        """
220
        self.control_files.dont_leave_in_place()
221
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
222
    def abspath(self, name):
223
        """Return absolute filename for something in the branch
224
        
225
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
226
        method and not a tree method.
227
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
228
        raise NotImplementedError(self.abspath)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
229
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
230
    def bind(self, other):
231
        """Bind the local branch the other branch.
232
233
        :param other: The branch to bind to
234
        :type other: Branch
235
        """
236
        raise errors.UpgradeRequired(self.base)
237
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.
238
    @needs_write_lock
239
    def fetch(self, from_branch, last_revision=None, pb=None):
240
        """Copy revisions from from_branch into this branch.
241
242
        :param from_branch: Where to copy from.
243
        :param last_revision: What revision to stop at (None for at the end
244
                              of the branch.
245
        :param pb: An optional progress bar to use.
246
247
        Returns the copied revision count and the failed revisions in a tuple:
248
        (copied, failures).
249
        """
250
        if self.base == from_branch.base:
1558.4.11 by Aaron Bentley
Allow merge against self, make fetching self a noop
251
            return (0, [])
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.
252
        if pb is None:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
253
            nested_pb = ui.ui_factory.nested_progress_bar()
1594.1.3 by Robert Collins
Fixup pb usage to use nested_progress_bar.
254
            pb = nested_pb
255
        else:
256
            nested_pb = 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.
257
258
        from_branch.lock_read()
259
        try:
260
            if last_revision is None:
261
                pb.update('get source history')
2230.3.9 by Aaron Bentley
Fix most fetch tests
262
                last_revision = from_branch.last_revision()
3240.1.7 by Aaron Bentley
Update from review comments
263
                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.
264
            return self.repository.fetch(from_branch.repository,
265
                                         revision_id=last_revision,
1594.1.3 by Robert Collins
Fixup pb usage to use nested_progress_bar.
266
                                         pb=nested_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.
267
        finally:
1594.1.3 by Robert Collins
Fixup pb usage to use nested_progress_bar.
268
            if nested_pb is not None:
269
                nested_pb.finished()
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.
270
            from_branch.unlock()
271
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
272
    def get_bound_location(self):
1558.7.6 by Aaron Bentley
Fixed typo (Olaf Conradi)
273
        """Return the URL of the branch we are bound to.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
274
275
        Older format branches cannot bind, please be sure to use a metadir
276
        branch.
277
        """
278
        return None
1740.3.1 by Jelmer Vernooij
Introduce and use CommitBuilder objects.
279
    
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
280
    def get_old_bound_location(self):
281
        """Return the URL of the branch we used to be bound to
282
        """
283
        raise errors.UpgradeRequired(self.base)
284
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
285
    def get_commit_builder(self, parents, config=None, timestamp=None, 
286
                           timezone=None, committer=None, revprops=None, 
287
                           revision_id=None):
288
        """Obtain a CommitBuilder for this branch.
289
        
290
        :param parents: Revision ids of the parents of the new revision.
291
        :param config: Optional configuration to use.
292
        :param timestamp: Optional timestamp recorded for commit.
293
        :param timezone: Optional timezone for timestamp.
294
        :param committer: Optional committer to set for commit.
295
        :param revprops: Optional dictionary of revision properties.
296
        :param revision_id: Optional revision id.
297
        """
298
299
        if config is None:
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
300
            config = self.get_config()
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
301
        
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
302
        return self.repository.get_commit_builder(self, parents, config,
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
303
            timestamp, timezone, committer, revprops, revision_id)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
304
2810.2.1 by Martin Pool
merge vincent and cleanup
305
    def get_master_branch(self, possible_transports=None):
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
306
        """Return the branch we are bound to.
307
        
308
        :return: Either a Branch, or None
309
        """
310
        return None
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
311
1770.3.2 by Jelmer Vernooij
Move BzrBranch.get_revision_delta() to Branch.get_revision_delta() as it is generic.
312
    def get_revision_delta(self, revno):
313
        """Return the delta for one revision.
314
315
        The delta is relative to its mainline predecessor, or the
316
        empty tree for revision 1.
317
        """
318
        assert isinstance(revno, int)
319
        rh = self.revision_history()
320
        if not (1 <= revno <= len(rh)):
3236.1.2 by Michael Hudson
clean up branch.py imports
321
            raise errors.InvalidRevisionNumber(revno)
1770.3.2 by Jelmer Vernooij
Move BzrBranch.get_revision_delta() to Branch.get_revision_delta() as it is generic.
322
        return self.repository.get_revision_delta(rh[revno-1])
323
1551.13.5 by Aaron Bentley
Deprecate Branch.get_root_id
324
    @deprecated_method(zero_sixteen)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
325
    def get_root_id(self):
1551.13.5 by Aaron Bentley
Deprecate Branch.get_root_id
326
        """Return the id of this branches root
327
328
        Deprecated: branches don't have root ids-- trees do.
329
        Use basis_tree().get_root_id() instead.
330
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
331
        raise NotImplementedError(self.get_root_id)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
332
1185.50.9 by John Arbash Meinel
[bug 3632] Matthieu Moy- bzr cat should default to last revision
333
    def print_file(self, file, revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
334
        """Print `file` to stdout."""
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
335
        raise NotImplementedError(self.print_file)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
336
337
    def set_revision_history(self, rev_history):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
338
        raise NotImplementedError(self.set_revision_history)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
339
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
340
    def _cache_revision_history(self, rev_history):
341
        """Set the cached revision history to rev_history.
342
343
        The revision_history method will use this cache to avoid regenerating
344
        the revision history.
345
346
        This API is semi-public; it only for use by subclasses, all other code
347
        should consider it to be private.
348
        """
349
        self._revision_history_cache = rev_history
350
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
351
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
352
        """Set the cached revision_id => revno map to revision_id_to_revno.
353
354
        This API is semi-public; it only for use by subclasses, all other code
355
        should consider it to be private.
356
        """
357
        self._revision_id_to_revno_cache = revision_id_to_revno
358
2375.1.6 by Andrew Bennetts
Rename _clear_cached_data to _clear_cached_state.
359
    def _clear_cached_state(self):
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
360
        """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.
361
362
        This means the next call to revision_history will need to call
363
        _gen_revision_history.
364
365
        This API is semi-public; it only for use by subclasses, all other code
366
        should consider it to be private.
367
        """
368
        self._revision_history_cache = None
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
369
        self._revision_id_to_revno_cache = None
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
370
371
    def _gen_revision_history(self):
372
        """Return sequence of revision hashes on to this branch.
373
        
374
        Unlike revision_history, this method always regenerates or rereads the
375
        revision history, i.e. it does not cache the result, so repeated calls
376
        may be expensive.
377
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
378
        Concrete subclasses should override this instead of revision_history so
379
        that subclasses do not need to deal with caching logic.
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
380
        
381
        This API is semi-public; it only for use by subclasses, all other code
382
        should consider it to be private.
383
        """
384
        raise NotImplementedError(self._gen_revision_history)
385
386
    @needs_read_lock
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
387
    def revision_history(self):
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
388
        """Return sequence of revision ids on this branch.
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
389
        
390
        This method will cache the revision history for as long as it is safe to
391
        do so.
392
        """
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
393
        if 'evil' in debug.debug_flags:
394
            mutter_callsite(3, "revision_history scales with history.")
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
395
        if self._revision_history_cache is not None:
2375.1.5 by Andrew Bennetts
Deal with review comments from Robert:
396
            history = self._revision_history_cache
397
        else:
398
            history = self._gen_revision_history()
399
            self._cache_revision_history(history)
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
400
        return list(history)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
401
402
    def revno(self):
403
        """Return current revision number for this branch.
404
405
        That is equivalent to the number of revisions committed to
406
        this branch.
407
        """
3066.1.1 by John Arbash Meinel
Make the default Branch.revno() implementation just be a thunk to last_revision_info.
408
        return self.last_revision_info()[0]
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
409
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
410
    def unbind(self):
411
        """Older format branches cannot bind or unbind."""
412
        raise errors.UpgradeRequired(self.base)
413
2230.3.40 by Aaron Bentley
Rename strict_revision_history to append_revisions_only
414
    def set_append_revisions_only(self, enabled):
415
        """Older format branches are never restricted to append-only"""
2230.3.32 by Aaron Bentley
Implement strict history policy
416
        raise errors.UpgradeRequired(self.base)
417
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
418
    def last_revision(self):
3211.2.1 by Robert Collins
* Creating a new branch no longer tries to read the entire revision-history
419
        """Return last revision id, or NULL_REVISION."""
420
        return self.last_revision_info()[1]
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
421
2249.4.1 by Wouter van Heyst
New Branch.last_revision_info method, this is being done to allow
422
    def last_revision_info(self):
423
        """Return information about the last revision.
424
425
        :return: A tuple (revno, last_revision_id).
426
        """
427
        rh = self.revision_history()
428
        revno = len(rh)
429
        if revno:
430
            return (revno, rh[-1])
431
        else:
432
            return (0, _mod_revision.NULL_REVISION)
433
1505.1.21 by John Arbash Meinel
Removing changes for bound branch by invading set-revision-history.
434
    def missing_revisions(self, other, stop_revision=None):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
435
        """Return a list of new revisions that would perfectly fit.
436
        
437
        If self and other have not diverged, return a list of the revisions
438
        present in other, but missing from self.
439
        """
440
        self_history = self.revision_history()
441
        self_len = len(self_history)
1505.1.21 by John Arbash Meinel
Removing changes for bound branch by invading set-revision-history.
442
        other_history = other.revision_history()
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
443
        other_len = len(other_history)
444
        common_index = min(self_len, other_len) -1
445
        if common_index >= 0 and \
446
            self_history[common_index] != other_history[common_index]:
3236.1.2 by Michael Hudson
clean up branch.py imports
447
            raise errors.DivergedBranches(self, other)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
448
449
        if stop_revision is None:
450
            stop_revision = other_len
451
        else:
452
            assert isinstance(stop_revision, int)
453
            if stop_revision > other_len:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
454
                raise errors.NoSuchRevision(self, stop_revision)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
455
        return other_history[self_len:stop_revision]
1185.66.1 by Aaron Bentley
Merged from mainline
456
1505.1.21 by John Arbash Meinel
Removing changes for bound branch by invading set-revision-history.
457
    def update_revisions(self, other, stop_revision=None):
1505.1.16 by John Arbash Meinel
[merge] robertc's integration, updated tests to check for retcode=3
458
        """Pull in new perfect-fit revisions.
459
460
        :param other: Another Branch to pull from
461
        :param stop_revision: Updated until the given revision
462
        :return: None
463
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
464
        raise NotImplementedError(self.update_revisions)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
465
466
    def revision_id_to_revno(self, revision_id):
467
        """Given a revision id, return its revno"""
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
468
        if _mod_revision.is_null(revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
469
            return 0
470
        history = self.revision_history()
471
        try:
472
            return history.index(revision_id) + 1
473
        except ValueError:
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
474
            raise errors.NoSuchRevision(self, revision_id)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
475
476
    def get_rev_id(self, revno, history=None):
477
        """Find the revision id of the specified revno."""
478
        if revno == 0:
2598.5.10 by Aaron Bentley
Return NULL_REVISION instead of None for the null revision
479
            return _mod_revision.NULL_REVISION
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
480
        if history is None:
481
            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
482
        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
483
            raise errors.NoSuchRevision(self, revno)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
484
        return history[revno - 1]
485
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
486
    def pull(self, source, overwrite=False, stop_revision=None,
487
             possible_transports=None):
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
488
        """Mirror source into this branch.
489
490
        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.
491
492
        :returns: PullResult instance
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
493
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
494
        raise NotImplementedError(self.pull)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
495
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
496
    def push(self, target, overwrite=False, stop_revision=None):
497
        """Mirror this branch into target.
498
499
        This branch is considered to be 'local', having low latency.
500
        """
501
        raise NotImplementedError(self.push)
502
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
503
    def basis_tree(self):
1852.5.1 by Robert Collins
Deprecate EmptyTree in favour of using Repository.revision_tree.
504
        """Return `Tree` object for last revision."""
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
505
        return self.repository.revision_tree(self.last_revision())
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
506
507
    def rename_one(self, from_rel, to_rel):
508
        """Rename one file.
509
510
        This can change the directory or the filename or both.
511
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
512
        raise NotImplementedError(self.rename_one)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
513
514
    def move(self, from_paths, to_name):
515
        """Rename files.
516
517
        to_name must exist as a versioned directory.
518
519
        If to_name exists and is a directory, the files are moved into
520
        it, keeping their old names.  If it is a directory, 
521
522
        Note that to_name is only the last component of the new name;
523
        this doesn't change the directory.
524
525
        This returns a list of (from_path, to_path) pairs for each
526
        entry that is moved.
527
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
528
        raise NotImplementedError(self.move)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
529
530
    def get_parent(self):
531
        """Return the parent location of the branch.
532
533
        This is the default location for push/pull/missing.  The usual
534
        pattern is that the user can override it by specifying a
535
        location.
536
        """
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
537
        raise NotImplementedError(self.get_parent)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
538
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
539
    def _set_config_location(self, name, url, config=None,
540
                             make_relative=False):
541
        if config is None:
542
            config = self.get_config()
543
        if url is None:
544
            url = ''
545
        elif make_relative:
546
            url = urlutils.relative_url(self.base, url)
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
547
        config.set_user_option(name, url, warn_masked=True)
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
548
549
    def _get_config_location(self, name, config=None):
550
        if config is None:
551
            config = self.get_config()
552
        location = config.get_user_option(name)
553
        if location == '':
554
            location = None
555
        return location
556
1804.1.1 by Aaron Bentley
Add support for submit location to bundles
557
    def get_submit_branch(self):
558
        """Return the submit location of the branch.
559
560
        This is the default location for bundle.  The usual
561
        pattern is that the user can override it by specifying a
562
        location.
563
        """
564
        return self.get_config().get_user_option('submit_branch')
565
566
    def set_submit_branch(self, location):
567
        """Return the submit location of the branch.
568
569
        This is the default location for bundle.  The usual
570
        pattern is that the user can override it by specifying a
571
        location.
572
        """
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
573
        self.get_config().set_user_option('submit_branch', location,
574
            warn_masked=True)
1804.1.1 by Aaron Bentley
Add support for submit location to bundles
575
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
576
    def get_public_branch(self):
577
        """Return the public location of the branch.
578
579
        This is is used by merge directives.
580
        """
581
        return self._get_config_location('public_branch')
582
583
    def set_public_branch(self, location):
584
        """Return the submit location of the branch.
585
586
        This is the default location for bundle.  The usual
587
        pattern is that the user can override it by specifying a
588
        location.
589
        """
590
        self._set_config_location('public_branch', location)
591
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
592
    def get_push_location(self):
593
        """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).
594
        push_loc = self.get_config().get_user_option('push_location')
595
        return push_loc
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
596
597
    def set_push_location(self, location):
598
        """Set a new push location for this branch."""
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
599
        raise NotImplementedError(self.set_push_location)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
600
601
    def set_parent(self, url):
1910.3.2 by Andrew Bennetts
Improve some NotImplementedErrors.
602
        raise NotImplementedError(self.set_parent)
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
603
1587.1.10 by Robert Collins
update updates working tree and branch together.
604
    @needs_write_lock
605
    def update(self):
606
        """Synchronise this branch with the master branch if any. 
607
608
        :return: None or the last_revision pivoted out during the update.
609
        """
610
        return None
611
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
612
    def check_revno(self, revno):
613
        """\
614
        Check whether a revno corresponds to any revision.
615
        Zero (the NULL revision) is considered valid.
616
        """
617
        if revno != 0:
618
            self.check_real_revno(revno)
619
            
620
    def check_real_revno(self, revno):
621
        """\
622
        Check whether a revno corresponds to a real revision.
623
        Zero (the NULL revision) is considered invalid
624
        """
625
        if revno < 1 or revno > self.revno():
3236.1.2 by Michael Hudson
clean up branch.py imports
626
            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.
627
628
    @needs_read_lock
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
629
    def clone(self, to_bzrdir, revision_id=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.
630
        """Clone this branch into to_bzrdir preserving all semantic values.
631
        
632
        revision_id: if not None, the revision history in the new branch will
633
                     be truncated to end with revision_id.
634
        """
635
        result = self._format.initialize(to_bzrdir)
636
        self.copy_content_into(result, revision_id=revision_id)
637
        return  result
638
639
    @needs_read_lock
640
    def sprout(self, to_bzrdir, revision_id=None):
641
        """Create a new line of development from the branch, into to_bzrdir.
642
        
643
        revision_id: if not None, the revision history in the new branch will
644
                     be truncated to end with revision_id.
645
        """
646
        result = self._format.initialize(to_bzrdir)
647
        self.copy_content_into(result, revision_id=revision_id)
648
        result.set_parent(self.bzrdir.root_transport.base)
649
        return result
650
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
651
    def _synchronize_history(self, destination, revision_id):
2230.3.35 by Aaron Bentley
Add documentation for synchonize_history
652
        """Synchronize last revision and revision history between branches.
653
654
        This version is most efficient when the destination is also a
655
        BzrBranch5, but works for BzrBranch6 as long as the revision
656
        history is the true lefthand parent history, and all of the revisions
657
        are in the destination's repository.  If not, set_revision_history
658
        will fail.
659
660
        :param destination: The branch to copy the history into
661
        :param revision_id: The revision-id to truncate history at.  May
662
          be None to copy complete history.
663
        """
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
664
        if revision_id == _mod_revision.NULL_REVISION:
665
            new_history = []
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
666
        new_history = self.revision_history()
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
667
        if revision_id is not None and new_history != []:
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
668
            try:
669
                new_history = new_history[:new_history.index(revision_id) + 1]
670
            except ValueError:
671
                rev = self.repository.get_revision(revision_id)
672
                new_history = rev.get_history(self.repository)[1:]
673
        destination.set_revision_history(new_history)
674
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.
675
    @needs_read_lock
676
    def copy_content_into(self, destination, revision_id=None):
677
        """Copy the content of self into destination.
678
679
        revision_id: if not None, the revision history in the new branch will
680
                     be truncated to end with revision_id.
681
        """
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
682
        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)
683
        try:
684
            parent = self.get_parent()
685
        except errors.InaccessibleParent, e:
686
            mutter('parent was not accessible to copy: %s', e)
687
        else:
688
            if parent:
689
                destination.set_parent(parent)
2348.2.1 by Marien Zwart
Properly push tags if push creates a new branch.
690
        self.tags.merge_to(destination.tags)
1185.66.1 by Aaron Bentley
Merged from mainline
691
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
692
    @needs_read_lock
693
    def check(self):
694
        """Check consistency of the branch.
695
696
        In particular this checks that revisions given in the revision-history
697
        do actually match up in the revision graph, and that they're all 
698
        present in the repository.
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
699
        
700
        Callers will typically also want to check the repository.
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
701
702
        :return: A BranchCheckResult.
703
        """
704
        mainline_parent_id = None
705
        for revision_id in self.revision_history():
706
            try:
707
                revision = self.repository.get_revision(revision_id)
708
            except errors.NoSuchRevision, e:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
709
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
710
                            % revision_id)
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
711
            # In general the first entry on the revision history has no parents.
712
            # But it's not illegal for it to have parents listed; this can happen
713
            # in imports from Arch when the parents weren't reachable.
714
            if mainline_parent_id is not None:
715
                if mainline_parent_id not in revision.parent_ids:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
716
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
717
                                        "parents of {%s}"
718
                                        % (mainline_parent_id, revision_id))
719
            mainline_parent_id = revision_id
720
        return BranchCheckResult(self)
721
1910.2.39 by Aaron Bentley
Fix checkout bug
722
    def _get_checkout_format(self):
723
        """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.
724
        Weaves are used if this branch's repository uses weaves.
1910.2.39 by Aaron Bentley
Fix checkout bug
725
        """
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.
726
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
727
            from bzrlib.repofmt import weaverepo
1910.2.39 by Aaron Bentley
Fix checkout bug
728
            format = bzrdir.BzrDirMetaFormat1()
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
729
            format.repository_format = weaverepo.RepositoryFormat7()
1910.2.39 by Aaron Bentley
Fix checkout bug
730
        else:
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
731
            format = self.repository.bzrdir.checkout_metadir()
2370.3.2 by John Arbash Meinel
Use BzrDir.set_branch_format() rather than setting it directly.
732
            format.set_branch_format(self._format)
1910.2.39 by Aaron Bentley
Fix checkout bug
733
        return format
734
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
735
    def create_checkout(self, to_location, revision_id=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
736
                        lightweight=False, accelerator_tree=None,
737
                        hardlink=False):
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
738
        """Create a checkout of a branch.
739
        
740
        :param to_location: The url to produce the checkout at
741
        :param revision_id: The revision to check out
1551.8.5 by Aaron Bentley
Change name to create_checkout
742
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
743
        produce a bound branch (heavyweight checkout)
3123.5.17 by Aaron Bentley
Update docs
744
        :param accelerator_tree: A tree which can be used for retrieving file
745
            contents more quickly than the revision tree, i.e. a workingtree.
746
            The revision tree will be used for cases where accelerator_tree's
747
            content is different.
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
748
        :param hardlink: If true, hard-link files from accelerator_tree,
749
            where possible.
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
750
        :return: The tree of the created checkout
751
        """
1910.2.39 by Aaron Bentley
Fix checkout bug
752
        t = transport.get_transport(to_location)
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
753
        t.ensure_base()
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
754
        if lightweight:
2100.3.26 by Aaron Bentley
checkout type is maintained for subtrees
755
            format = self._get_checkout_format()
756
            checkout = format.initialize_on_transport(t)
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
757
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
758
        else:
1910.2.39 by Aaron Bentley
Fix checkout bug
759
            format = self._get_checkout_format()
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
760
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1910.2.39 by Aaron Bentley
Fix checkout bug
761
                to_location, force_new_tree=False, format=format)
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
762
            checkout = checkout_branch.bzrdir
763
            checkout_branch.bind(self)
1997.1.5 by Robert Collins
``Branch.bind(other_branch)`` no longer takes a write lock on the
764
            # pull up to the specified revision_id to set the initial 
765
            # branch tip correctly, and seed it with history.
766
            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.
767
            from_branch=None
768
        tree = checkout.create_workingtree(revision_id,
3123.5.2 by Aaron Bentley
Allow checkout --files_from
769
                                           from_branch=from_branch,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
770
                                           accelerator_tree=accelerator_tree,
771
                                           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.
772
        basis_tree = tree.basis_tree()
773
        basis_tree.lock_read()
774
        try:
775
            for path, file_id in basis_tree.iter_references():
776
                reference_parent = self.reference_parent(file_id, path)
777
                reference_parent.create_checkout(tree.abspath(path),
778
                    basis_tree.get_reference_revision(file_id, path),
779
                    lightweight)
780
        finally:
781
            basis_tree.unlock()
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
782
        return tree
1551.8.3 by Aaron Bentley
Make create_checkout_convenience a Branch method
783
2100.3.23 by Aaron Bentley
Nested checkouts kinda work
784
    def reference_parent(self, file_id, path):
2100.3.29 by Aaron Bentley
Get merge working initially
785
        """Return the parent branch for a tree-reference file_id
786
        :param file_id: The file_id of the tree reference
787
        :param path: The path of the file_id in the tree
788
        :return: A branch associated with the file_id
789
        """
790
        # FIXME should provide multiple branches, based on config
2100.3.23 by Aaron Bentley
Nested checkouts kinda work
791
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
792
2220.2.30 by Martin Pool
split out tag-merging code and add some tests
793
    def supports_tags(self):
794
        return self._format.supports_tags()
795
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
796
797
class BranchFormat(object):
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
798
    """An encapsulation of the initialization and open routines for a format.
799
800
    Formats provide three things:
801
     * An initialization routine,
802
     * a format string,
803
     * an open routine.
804
805
    Formats are placed in an dict by their format string for reference 
806
    during branch opening. Its not required that these be instances, they
807
    can be classes themselves with class methods - it simply depends on 
808
    whether state is needed for a given format or not.
809
810
    Once a format is deprecated, just deprecate the initialize and open
811
    methods on the format class. Do not deprecate the object, as the 
812
    object will be created every time regardless.
813
    """
814
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
815
    _default_format = None
816
    """The default format used for new branches."""
817
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
818
    _formats = {}
819
    """The known formats."""
820
2363.5.5 by Aaron Bentley
add info.describe_format
821
    def __eq__(self, other):
822
        return self.__class__ is other.__class__
823
824
    def __ne__(self, other):
825
        return not (self == other)
826
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
827
    @classmethod
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
828
    def find_format(klass, a_bzrdir):
829
        """Return the format for the branch object in a_bzrdir."""
830
        try:
831
            transport = a_bzrdir.get_branch_transport(None)
832
            format_string = transport.get("format").read()
833
            return klass._formats[format_string]
3236.1.2 by Michael Hudson
clean up branch.py imports
834
        except errors.NoSuchFile:
835
            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.
836
        except KeyError:
1740.5.6 by Martin Pool
Clean up many exception classes.
837
            raise errors.UnknownFormatError(format=format_string)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
838
839
    @classmethod
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
840
    def get_default_format(klass):
841
        """Return the current default format."""
842
        return klass._default_format
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
843
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
844
    def get_reference(self, a_bzrdir):
845
        """Get the target reference of the branch in a_bzrdir.
846
847
        format probing must have been completed before calling
848
        this method - it is assumed that the format of the branch
849
        in a_bzrdir is correct.
850
851
        :param a_bzrdir: The bzrdir to get the branch data from.
852
        :return: None if the branch is not a reference branch.
853
        """
854
        return None
855
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
856
    @classmethod
857
    def set_reference(self, a_bzrdir, to_branch):
858
        """Set the target reference of the branch in a_bzrdir.
859
860
        format probing must have been completed before calling
861
        this method - it is assumed that the format of the branch
862
        in a_bzrdir is correct.
863
864
        :param a_bzrdir: The bzrdir to set the branch reference for.
865
        :param to_branch: branch that the checkout is to reference
866
        """
867
        raise NotImplementedError(self.set_reference)
868
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
869
    def get_format_string(self):
870
        """Return the ASCII format string that identifies this format."""
871
        raise NotImplementedError(self.get_format_string)
872
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
873
    def get_format_description(self):
874
        """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).
875
        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
876
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
877
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
878
                           set_format=True):
879
        """Initialize a branch in a bzrdir, with specified files
880
881
        :param a_bzrdir: The bzrdir to initialize the branch in
882
        :param utf8_files: The files to create as a list of
883
            (filename, content) tuples
884
        :param set_format: If True, set the format with
885
            self.get_format_string.  (BzrBranch4 has its format set
886
            elsewhere)
887
        :return: a branch in this format
888
        """
889
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
890
        branch_transport = a_bzrdir.get_branch_transport(self)
891
        lock_map = {
892
            'metadir': ('lock', lockdir.LockDir),
893
            'branch4': ('branch-lock', lockable_files.TransportLock),
894
        }
895
        lock_name, lock_class = lock_map[lock_type]
896
        control_files = lockable_files.LockableFiles(branch_transport,
897
            lock_name, lock_class)
898
        control_files.create_lock()
899
        control_files.lock_write()
900
        if set_format:
901
            control_files.put_utf8('format', self.get_format_string())
902
        try:
903
            for file, content in utf8_files:
904
                control_files.put_utf8(file, content)
905
        finally:
906
            control_files.unlock()
907
        return self.open(a_bzrdir, _found=True)
908
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
909
    def initialize(self, a_bzrdir):
910
        """Create a branch of this format in a_bzrdir."""
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
911
        raise NotImplementedError(self.initialize)
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
912
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.
913
    def is_supported(self):
914
        """Is this format supported?
915
916
        Supported formats can be initialized and opened.
917
        Unsupported formats may not support initialization or committing or 
918
        some other features depending on the reason for not being supported.
919
        """
920
        return True
921
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
922
    def open(self, a_bzrdir, _found=False):
923
        """Return the branch object for a_bzrdir
924
925
        _found is a private parameter, do not use it. It is used to indicate
926
               if format probing has already be done.
927
        """
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
928
        raise NotImplementedError(self.open)
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
929
930
    @classmethod
931
    def register_format(klass, format):
932
        klass._formats[format.get_format_string()] = format
933
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.
934
    @classmethod
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
935
    def set_default_format(klass, format):
936
        klass._default_format = format
937
938
    @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.
939
    def unregister_format(klass, format):
940
        assert klass._formats[format.get_format_string()] is format
941
        del klass._formats[format.get_format_string()]
942
1553.4.8 by Michael Ellerman
Define __str__ for BranchFormat, just return the format string with the
943
    def __str__(self):
944
        return self.get_format_string().rstrip()
945
2220.2.10 by Martin Pool
(broken) start moving things to branches
946
    def supports_tags(self):
947
        """True if this format supports tags stored in the branch"""
948
        return False  # by default
949
2220.2.12 by mbp at sourcefrog
BzrBranchExperimental can now act as its own format
950
    # XXX: Probably doesn't really belong here -- mbp 20070212
2220.2.10 by Martin Pool
(broken) start moving things to branches
951
    def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
952
            lock_class):
953
        branch_transport = a_bzrdir.get_branch_transport(self)
954
        control_files = lockable_files.LockableFiles(branch_transport,
955
            lock_filename, lock_class)
956
        control_files.create_lock()
957
        control_files.lock_write()
958
        try:
959
            for filename, content in utf8_files:
960
                control_files.put_utf8(filename, content)
961
        finally:
962
            control_files.unlock()
963
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
964
2370.4.1 by Robert Collins
New SmartServer hooks facility. There are two initial hooks documented
965
class BranchHooks(Hooks):
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
966
    """A dictionary mapping hook name to a list of callables for branch hooks.
967
    
968
    e.g. ['set_rh'] Is the list of items to be called when the
969
    set_revision_history function is invoked.
970
    """
971
972
    def __init__(self):
973
        """Create the default hooks.
974
975
        These are all empty initially, because by default nothing should get
976
        notified.
977
        """
2370.4.1 by Robert Collins
New SmartServer hooks facility. There are two initial hooks documented
978
        Hooks.__init__(self)
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
979
        # Introduced in 0.15:
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
980
        # invoked whenever the revision history has been set
981
        # with set_revision_history. The api signature is
982
        # (branch, revision_history), and the branch will
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
983
        # be write-locked.
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
984
        self['set_rh'] = []
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
985
        # invoked after a push operation completes.
986
        # the api signature is
2297.1.5 by Martin Pool
Update hook docs
987
        # (push_result)
988
        # containing the members
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
989
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
990
        # where local is the local target branch or None, master is the target 
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
991
        # master branch, and the rest should be self explanatory. The source
992
        # is read locked and the target branches write locked. Source will
993
        # be the local low-latency branch.
994
        self['post_push'] = []
995
        # invoked after a pull operation completes.
996
        # the api signature is
2297.1.5 by Martin Pool
Update hook docs
997
        # (pull_result)
998
        # containing the members
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
999
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
        # where local is the local branch or None, master is the target 
1001
        # master branch, and the rest should be self explanatory. The source
1002
        # is read locked and the target branches write locked. The local
1003
        # branch is the low-latency branch.
1004
        self['post_pull'] = []
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
1005
        # invoked before a commit operation takes place.
1006
        # the api signature is
1007
        # (local, master, old_revno, old_revid, future_revno, future_revid,
2659.3.9 by NamNguyen
branch.py:
1008
        #  tree_delta, future_tree).
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
1009
        # old_revid is NULL_REVISION for the first commit to a branch
2659.3.9 by NamNguyen
branch.py:
1010
        # tree_delta is a TreeDelta object describing changes from the basis
1011
        # revision, hooks MUST NOT modify this delta
1012
        # future_tree is an in-memory tree obtained from
1013
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
1014
        self['pre_commit'] = []
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1015
        # invoked after a commit operation completes.
1016
        # the api signature is 
1017
        # (local, master, old_revno, old_revid, new_revno, new_revid)
1018
        # old_revid is NULL_REVISION for the first commit to a branch.
1019
        self['post_commit'] = []
1020
        # invoked after a uncommit operation completes.
1021
        # the api signature is
1022
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
1023
        # local is the local branch or None, master is the target branch,
1024
        # and an empty branch recieves new_revno of 0, new_revid of None.
1025
        self['post_uncommit'] = []
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
1026
1027
1028
# install the default hooks into the Branch class.
1029
Branch.hooks = BranchHooks()
1030
1031
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1032
class BzrBranchFormat4(BranchFormat):
1534.4.2 by Robert Collins
Introduce BranchFormats - factoring out intialisation of Branches.
1033
    """Bzr branch format 4.
1034
1035
    This format has:
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1036
     - 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.
1037
     - a branch-lock lock file [ to be shared with the bzrdir ]
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1038
    """
1039
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
1040
    def get_format_description(self):
1041
        """See BranchFormat.get_format_description()."""
1042
        return "Branch format 4"
1043
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1044
    def initialize(self, a_bzrdir):
1045
        """Create a branch of this format in a_bzrdir."""
1046
        utf8_files = [('revision-history', ''),
1047
                      ('branch-name', ''),
1048
                      ]
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1049
        return self._initialize_helper(a_bzrdir, utf8_files,
1050
                                       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.
1051
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1052
    def __init__(self):
1053
        super(BzrBranchFormat4, self).__init__()
1054
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1055
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1056
    def open(self, a_bzrdir, _found=False):
1057
        """Return the branch object for a_bzrdir
1058
1059
        _found is a private parameter, do not use it. It is used to indicate
1060
               if format probing has already be done.
1061
        """
1062
        if not _found:
1063
            # we are being called directly and must probe.
1064
            raise NotImplementedError
1065
        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.
1066
                         _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.
1067
                         a_bzrdir=a_bzrdir,
1068
                         _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.
1069
1553.4.8 by Michael Ellerman
Define __str__ for BranchFormat, just return the format string with the
1070
    def __str__(self):
1071
        return "Bazaar-NG branch format 4"
1072
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1073
1074
class BzrBranchFormat5(BranchFormat):
1075
    """Bzr branch format 5.
1076
1077
    This format has:
1078
     - a revision-history file.
1079
     - a format string
1553.5.71 by Martin Pool
Change branch format 5 to use LockDirs, not transport locks
1080
     - a lock dir guarding the branch itself
1081
     - 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.
1082
     - works with shared repositories.
1553.5.71 by Martin Pool
Change branch format 5 to use LockDirs, not transport locks
1083
1084
    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.
1085
    """
1086
1087
    def get_format_string(self):
1088
        """See BranchFormat.get_format_string()."""
1089
        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
1090
1091
    def get_format_description(self):
1092
        """See BranchFormat.get_format_description()."""
1093
        return "Branch format 5"
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1094
        
1095
    def initialize(self, a_bzrdir):
1096
        """Create a branch of this format in a_bzrdir."""
1097
        utf8_files = [('revision-history', ''),
1098
                      ('branch-name', ''),
1099
                      ]
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1100
        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.
1101
1102
    def __init__(self):
1103
        super(BzrBranchFormat5, self).__init__()
1104
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1105
1106
    def open(self, a_bzrdir, _found=False):
1107
        """Return the branch object for a_bzrdir
1108
1109
        _found is a private parameter, do not use it. It is used to indicate
1110
               if format probing has already be done.
1111
        """
1112
        if not _found:
1113
            format = BranchFormat.find_format(a_bzrdir)
1114
            assert format.__class__ == self.__class__
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
1115
        try:
1116
            transport = a_bzrdir.get_branch_transport(None)
1752.2.86 by Andrew Bennetts
Merge from bzr.dev.
1117
            control_files = lockable_files.LockableFiles(transport, 'lock',
1118
                                                         lockdir.LockDir)
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
1119
            return BzrBranch5(_format=self,
1120
                              _control_files=control_files,
1121
                              a_bzrdir=a_bzrdir,
1122
                              _repository=a_bzrdir.find_repository())
3236.1.2 by Michael Hudson
clean up branch.py imports
1123
        except errors.NoSuchFile:
1124
            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.
1125
2220.2.10 by Martin Pool
(broken) start moving things to branches
1126
2230.3.1 by Aaron Bentley
Get branch6 creation working
1127
class BzrBranchFormat6(BzrBranchFormat5):
2696.3.1 by Martin Pool
(broken) start switching format to dirstate-tags
1128
    """Branch format with last-revision and tags.
2230.3.12 by Aaron Bentley
Clean up trailing whitespace
1129
2230.3.38 by Aaron Bentley
Update docs per Martin's suggestion
1130
    Unlike previous formats, this has no explicit revision history. Instead,
1131
    this just stores the last-revision, and the left-hand history leading
1132
    up to there is the history.
1133
1134
    This format was introduced in bzr 0.15
2696.3.1 by Martin Pool
(broken) start switching format to dirstate-tags
1135
    and became the default in 0.91.
2230.3.1 by Aaron Bentley
Get branch6 creation working
1136
    """
1137
1138
    def get_format_string(self):
1139
        """See BranchFormat.get_format_string()."""
2255.2.230 by Robert Collins
Update tree format signatures to mention introducing bzr version.
1140
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2230.3.1 by Aaron Bentley
Get branch6 creation working
1141
1142
    def get_format_description(self):
1143
        """See BranchFormat.get_format_description()."""
1144
        return "Branch format 6"
1145
1146
    def initialize(self, a_bzrdir):
1147
        """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
1148
        utf8_files = [('last-revision', '0 null:\n'),
2220.2.28 by Martin Pool
Integrate tags with Branch6:
1149
                      ('branch.conf', ''),
1150
                      ('tags', ''),
2230.3.1 by Aaron Bentley
Get branch6 creation working
1151
                      ]
2230.3.37 by Aaron Bentley
Refactor BranchFormat._initialize_helper out of BzrBranchFormat[4-6]
1152
        return self._initialize_helper(a_bzrdir, utf8_files)
2230.3.1 by Aaron Bentley
Get branch6 creation working
1153
1154
    def open(self, a_bzrdir, _found=False):
1155
        """Return the branch object for a_bzrdir
1156
1157
        _found is a private parameter, do not use it. It is used to indicate
1158
               if format probing has already be done.
1159
        """
1160
        if not _found:
1161
            format = BranchFormat.find_format(a_bzrdir)
1162
            assert format.__class__ == self.__class__
1163
        transport = a_bzrdir.get_branch_transport(None)
1164
        control_files = lockable_files.LockableFiles(transport, 'lock',
1165
                                                     lockdir.LockDir)
1166
        return BzrBranch6(_format=self,
1167
                          _control_files=control_files,
1168
                          a_bzrdir=a_bzrdir,
1169
                          _repository=a_bzrdir.find_repository())
1170
2220.2.27 by Martin Pool
Start adding tags to Branch6
1171
    def supports_tags(self):
1172
        return True
1173
2230.3.1 by Aaron Bentley
Get branch6 creation working
1174
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.
1175
class BranchReferenceFormat(BranchFormat):
1176
    """Bzr branch reference format.
1177
1178
    Branch references are used in implementing checkouts, they
1179
    act as an alias to the real branch which is at some other url.
1180
1181
    This format has:
1182
     - A location file
1183
     - a format string
1184
    """
1185
1186
    def get_format_string(self):
1187
        """See BranchFormat.get_format_string()."""
1188
        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
1189
1190
    def get_format_description(self):
1191
        """See BranchFormat.get_format_description()."""
1192
        return "Checkout reference format 1"
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
1193
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
1194
    def get_reference(self, a_bzrdir):
1195
        """See BranchFormat.get_reference()."""
1196
        transport = a_bzrdir.get_branch_transport(None)
1197
        return transport.get('location').read()
1198
3078.2.1 by Ian Clatworthy
Refactor switch to support heavyweight checkouts
1199
    def set_reference(self, a_bzrdir, to_branch):
1200
        """See BranchFormat.set_reference()."""
1201
        transport = a_bzrdir.get_branch_transport(None)
1202
        location = transport.put_bytes('location', to_branch.base)
1203
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.
1204
    def initialize(self, a_bzrdir, target_branch=None):
1205
        """Create a branch of this format in a_bzrdir."""
1206
        if target_branch is None:
1207
            # this format does not implement branch itself, thus the implicit
1208
            # creation contract must see it as uninitializable
1209
            raise errors.UninitializableFormat(self)
1210
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1211
        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
1212
        branch_transport.put_bytes('location',
1955.3.25 by John Arbash Meinel
apply a FIXME
1213
            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
1214
        branch_transport.put_bytes('format', self.get_format_string())
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
1215
        return self.open(
1216
            a_bzrdir, _found=True,
1217
            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.
1218
1219
    def __init__(self):
1220
        super(BranchReferenceFormat, self).__init__()
1221
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1222
1223
    def _make_reference_clone_function(format, a_branch):
1224
        """Create a clone() routine for a branch dynamically."""
1225
        def clone(to_bzrdir, revision_id=None):
1226
            """See Branch.clone()."""
1227
            return format.initialize(to_bzrdir, a_branch)
1228
            # cannot obey revision_id limits when cloning a reference ...
1229
            # FIXME RBC 20060210 either nuke revision_id for clone, or
1230
            # emit some sort of warning/error to the caller ?!
1231
        return clone
1232
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
1233
    def open(self, a_bzrdir, _found=False, location=None,
1234
             possible_transports=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.
1235
        """Return the branch that the branch reference in a_bzrdir points at.
1236
1237
        _found is a private parameter, do not use it. It is used to indicate
1238
               if format probing has already be done.
1239
        """
1240
        if not _found:
1241
            format = BranchFormat.find_format(a_bzrdir)
1242
            assert format.__class__ == self.__class__
2018.6.1 by Robert Collins
Implement a BzrDir.open_branch smart server method for opening a branch without VFS.
1243
        if location is None:
1244
            location = self.get_reference(a_bzrdir)
2955.5.2 by Vincent Ladeuil
Fix first unwanted connection.
1245
        real_bzrdir = bzrdir.BzrDir.open(
1246
            location, possible_transports=possible_transports)
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.
1247
        result = real_bzrdir.open_branch()
1248
        # this changes the behaviour of result.clone to create a new reference
1249
        # rather than a copy of the content of the branch.
1250
        # I did not use a proxy object because that needs much more extensive
1251
        # testing, and we are only changing one behaviour at the moment.
1252
        # If we decide to alter more behaviours - i.e. the implicit nickname
1253
        # then this should be refactored to introduce a tested proxy branch
1254
        # and a subclass of that for use in overriding clone() and ....
1255
        # - RBC 20060210
1256
        result.clone = self._make_reference_clone_function(result)
1257
        return result
1258
1259
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1260
# formats which have no format string are not discoverable
1261
# and not independently creatable, so are not registered.
2696.3.3 by Martin Pool
Start setting the default format to dirstate-tags
1262
__format5 = BzrBranchFormat5()
1263
__format6 = BzrBranchFormat6()
1264
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.
1265
BranchFormat.register_format(BranchReferenceFormat())
2696.3.3 by Martin Pool
Start setting the default format to dirstate-tags
1266
BranchFormat.register_format(__format6)
1267
BranchFormat.set_default_format(__format6)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1268
_legacy_formats = [BzrBranchFormat4(),
1269
                   ]
1534.4.5 by Robert Collins
Turn branch format.open into a factory.
1270
1495.1.5 by Jelmer Vernooij
Rename NativeBranch -> BzrBranch
1271
class BzrBranch(Branch):
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
1272
    """A branch stored in the actual filesystem.
1273
1274
    Note that it's "local" in the context of the filesystem; it doesn't
1275
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1276
    it's writable, and can be accessed via the normal filesystem API.
1 by mbp at sourcefrog
import from baz patch-364
1277
    """
353 by Martin Pool
- Per-branch locks in read and write modes.
1278
    
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
1279
    def __init__(self, _format=None,
1534.6.4 by Robert Collins
Creating or opening a branch will use the repository if the format supports that.
1280
                 _control_files=None, a_bzrdir=None, _repository=None):
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
1281
        """Create new branch object at a particular location."""
2220.2.11 by mbp at sourcefrog
Get tag tests working again, stored in the Branch
1282
        Branch.__init__(self)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1283
        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)
1284
            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.
1285
        else:
1286
            self.bzrdir = a_bzrdir
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
1287
        # self._transport used to point to the directory containing the
1288
        # control directory, but was not used - now it's just the transport
1289
        # for the branch control files.  mbp 20070212
1290
        self._base = self.bzrdir.transport.clone('..').base
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1291
        self._format = _format
1534.4.28 by Robert Collins
first cut at merge from integration.
1292
        if _control_files is None:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1293
            raise ValueError('BzrBranch _control_files is None')
1534.4.28 by Robert Collins
first cut at merge from integration.
1294
        self.control_files = _control_files
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
1295
        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.
1296
        self.repository = _repository
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
1297
1 by mbp at sourcefrog
import from baz patch-364
1298
    def __str__(self):
1185.65.11 by Robert Collins
Disable inheritance for getting at LockableFiles, rather use composition.
1299
        return '%s(%r)' % (self.__class__.__name__, self.base)
1 by mbp at sourcefrog
import from baz patch-364
1300
1301
    __repr__ = __str__
1302
907.1.17 by John Arbash Meinel
Adding a Branch.base property, removing pull_loc()
1303
    def _get_base(self):
2220.2.16 by mbp at sourcefrog
Make Branch._transport be the branch's control file transport
1304
        """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
1305
        return self._base
907.1.17 by John Arbash Meinel
Adding a Branch.base property, removing pull_loc()
1306
1442.1.5 by Robert Collins
Give branch.base a docstring.
1307
    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,
1308
67 by mbp at sourcefrog
use abspath() for the function that makes an absolute
1309
    def abspath(self, name):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1310
        """See Branch.abspath."""
1185.65.11 by Robert Collins
Disable inheritance for getting at LockableFiles, rather use composition.
1311
        return self.control_files._transport.abspath(name)
1185.58.4 by John Arbash Meinel
Added permission checking to Branch, and propogated that change into the stores.
1312
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
1313
1551.13.5 by Aaron Bentley
Deprecate Branch.get_root_id
1314
    @deprecated_method(zero_sixteen)
1508.1.15 by Robert Collins
Merge from mpool.
1315
    @needs_read_lock
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
1316
    def get_root_id(self):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1317
        """See Branch.get_root_id."""
1534.4.28 by Robert Collins
first cut at merge from integration.
1318
        tree = self.repository.revision_tree(self.last_revision())
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
1319
        return tree.get_root_id()
1 by mbp at sourcefrog
import from baz patch-364
1320
1694.2.6 by Martin Pool
[merge] bzr.dev
1321
    def is_locked(self):
1322
        return self.control_files.is_locked()
1323
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).
1324
    def lock_write(self, token=None):
1325
        repo_token = self.repository.lock_write()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1326
        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).
1327
            token = self.control_files.lock_write(token=token)
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1328
        except:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1329
            self.repository.unlock()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1330
            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).
1331
        return token
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
1332
1185.65.3 by Aaron Bentley
Fixed locking-- all tests pass
1333
    def lock_read(self):
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1334
        self.repository.lock_read()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1335
        try:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1336
            self.control_files.lock_read()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1337
        except:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1338
            self.repository.unlock()
1711.8.1 by John Arbash Meinel
Branch.lock_read/lock_write/unlock should handle failures
1339
            raise
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
1340
1341
    def unlock(self):
1185.65.11 by Robert Collins
Disable inheritance for getting at LockableFiles, rather use composition.
1342
        # TODO: test for failed two phase locks. This is known broken.
1687.1.8 by Robert Collins
Teach Branch about break_lock.
1343
        try:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1344
            self.control_files.unlock()
1687.1.8 by Robert Collins
Teach Branch about break_lock.
1345
        finally:
1711.8.3 by John Arbash Meinel
Branch should lock Repository before it locks self, and unlock self before Repository
1346
            self.repository.unlock()
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
1347
        if not self.control_files.is_locked():
1348
            # we just released the lock
2375.1.6 by Andrew Bennetts
Rename _clear_cached_data to _clear_cached_state.
1349
            self._clear_cached_state()
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1350
        
1185.70.3 by Martin Pool
Various updates to make storage branch mergeable:
1351
    def peek_lock_mode(self):
1352
        if self.control_files._lock_count == 0:
1353
            return None
1354
        else:
1355
            return self.control_files._lock_mode
1356
1694.2.6 by Martin Pool
[merge] bzr.dev
1357
    def get_physical_lock_status(self):
1358
        return self.control_files.get_physical_lock_status()
1359
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1360
    @needs_read_lock
1185.50.9 by John Arbash Meinel
[bug 3632] Matthieu Moy- bzr cat should default to last revision
1361
    def print_file(self, file, revision_id):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1362
        """See Branch.print_file."""
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
1363
        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.
1364
2230.3.49 by Aaron Bentley
Fix cache updating
1365
    def _write_revision_history(self, history):
1366
        """Factored out of set_revision_history.
1367
1368
        This performs the actual writing to disk.
1369
        It is intended to be called by BzrBranch5.set_revision_history."""
2249.5.17 by John Arbash Meinel
[merge] bzr.dev 2293 and resolve conflicts, but still broken
1370
        self.control_files.put_bytes(
2230.3.49 by Aaron Bentley
Fix cache updating
1371
            'revision-history', '\n'.join(history))
1372
1442.1.68 by Robert Collins
'bzr pull' now accepts '--clobber'.
1373
    @needs_write_lock
1374
    def set_revision_history(self, rev_history):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1375
        """See Branch.set_revision_history."""
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
1376
        if 'evil' in debug.debug_flags:
1377
            mutter_callsite(3, "set_revision_history scales with history.")
2418.5.6 by John Arbash Meinel
Cache the revision_id => revno map as appropriate.
1378
        self._clear_cached_state()
2230.3.49 by Aaron Bentley
Fix cache updating
1379
        self._write_revision_history(rev_history)
2375.1.3 by Andrew Bennetts
Don't use Branch.get_transaction to cache revision history.
1380
        self._cache_revision_history(rev_history)
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
1381
        for hook in Branch.hooks['set_rh']:
1382
            hook(self, rev_history)
233 by mbp at sourcefrog
- more output from test.sh
1383
2230.3.5 by Aaron Bentley
implement set_last revision and clone
1384
    @needs_write_lock
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1385
    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
1386
        """Set the last revision of this branch.
1387
1388
        The caller is responsible for checking that the revno is correct
1389
        for this revision id.
1390
1391
        It may be possible to set the branch last revision to an id not
1392
        present in the repository.  However, branches can also be 
1393
        configured to check constraints on history, in which case this may not
1394
        be permitted.
1395
        """
3240.1.7 by Aaron Bentley
Update from review comments
1396
        revision_id = _mod_revision.ensure_null(revision_id)
2697.2.5 by Martin Pool
Kill off append_revision
1397
        history = self._lefthand_history(revision_id)
1398
        assert len(history) == revno, '%d != %d' % (len(history), revno)
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1399
        self.set_revision_history(history)
2230.3.5 by Aaron Bentley
implement set_last revision and clone
1400
2230.4.1 by Aaron Bentley
Get log as fast branch5
1401
    def _gen_revision_history(self):
2309.4.11 by John Arbash Meinel
Change Branch5._gen_revision_history() to be a bit faster about reading all revisions.
1402
        history = self.control_files.get('revision-history').read().split('\n')
1403
        if history[-1:] == ['']:
1404
            # There shouldn't be a trailing newline, but just in case.
1405
            history.pop()
2230.4.1 by Aaron Bentley
Get log as fast branch5
1406
        return history
1407
2230.3.2 by Aaron Bentley
Get all branch tests passing
1408
    def _lefthand_history(self, revision_id, last_rev=None,
1409
                          other_branch=None):
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
1410
        if 'evil' in debug.debug_flags:
1411
            mutter_callsite(4, "_lefthand_history scales with history.")
1792.1.1 by Robert Collins
Factor out revision-history synthesis to make it reusable as Branch.generate_revision_history.
1412
        # stop_revision must be a descendant of last_revision
3240.1.3 by Aaron Bentley
Use Graph to generate revision_history
1413
        graph = self.repository.get_graph()
1414
        if last_rev is not None:
1415
            if not graph.is_ancestor(last_rev, revision_id):
1416
                # our previous tip is not merged into stop_revision
1417
                raise errors.DivergedBranches(self, other_branch)
1792.1.1 by Robert Collins
Factor out revision-history synthesis to make it reusable as Branch.generate_revision_history.
1418
        # make a new revision history from the graph
3240.1.4 by Aaron Bentley
Simplify _lefthand_history code
1419
        parents_map = graph.get_parent_map([revision_id])
1420
        if revision_id not in parents_map:
1421
            raise errors.NoSuchRevision(self, revision_id)
1422
        current_rev_id = revision_id
1792.1.1 by Robert Collins
Factor out revision-history synthesis to make it reusable as Branch.generate_revision_history.
1423
        new_history = []
3240.1.5 by Aaron Bentley
Further clean-ups, move None conversion out into API functions
1424
        # Do not include ghosts or graph origin in revision_history
1425
        while (current_rev_id in parents_map and
1426
               len(parents_map[current_rev_id]) > 0):
1792.1.1 by Robert Collins
Factor out revision-history synthesis to make it reusable as Branch.generate_revision_history.
1427
            new_history.append(current_rev_id)
3240.1.5 by Aaron Bentley
Further clean-ups, move None conversion out into API functions
1428
            current_rev_id = parents_map[current_rev_id][0]
3240.1.4 by Aaron Bentley
Simplify _lefthand_history code
1429
            parents_map = graph.get_parent_map([current_rev_id])
1792.1.1 by Robert Collins
Factor out revision-history synthesis to make it reusable as Branch.generate_revision_history.
1430
        new_history.reverse()
2230.3.2 by Aaron Bentley
Get all branch tests passing
1431
        return new_history
1432
1433
    @needs_write_lock
2230.3.12 by Aaron Bentley
Clean up trailing whitespace
1434
    def generate_revision_history(self, revision_id, last_rev=None,
2230.3.2 by Aaron Bentley
Get all branch tests passing
1435
        other_branch=None):
1436
        """Create a new revision history that will finish with revision_id.
2230.3.12 by Aaron Bentley
Clean up trailing whitespace
1437
2230.3.2 by Aaron Bentley
Get all branch tests passing
1438
        :param revision_id: the new tip to use.
1439
        :param last_rev: The previous last_revision. If not None, then this
1440
            must be a ancestory of revision_id, or DivergedBranches is raised.
1441
        :param other_branch: The other branch that DivergedBranches should
1442
            raise with respect to.
1443
        """
1444
        self.set_revision_history(self._lefthand_history(revision_id,
1445
            last_rev, other_branch))
1792.1.1 by Robert Collins
Factor out revision-history synthesis to make it reusable as Branch.generate_revision_history.
1446
1447
    @needs_write_lock
3052.5.4 by John Arbash Meinel
If we are going to overwrite the target, we don't have to do
1448
    def update_revisions(self, other, stop_revision=None, overwrite=False):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1449
        """See Branch.update_revisions."""
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1450
        other.lock_read()
1451
        try:
3052.5.1 by John Arbash Meinel
(bug #172970) Change Branch.pull to need to generate_history less often.
1452
            other_last_revno, other_last_revision = other.last_revision_info()
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1453
            if stop_revision is None:
3052.5.1 by John Arbash Meinel
(bug #172970) Change Branch.pull to need to generate_history less often.
1454
                stop_revision = other_last_revision
1455
                if _mod_revision.is_null(stop_revision):
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1456
                    # if there are no commits, we're done.
1457
                    return
1458
            # whats the current last revision, before we fetch [and change it
1459
            # possibly]
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
1460
            last_rev = _mod_revision.ensure_null(self.last_revision())
2592.3.113 by Robert Collins
Various -Devil checks in branch.py.
1461
            # we fetch here so that we don't process data twice in the common
1462
            # case of having something to pull, and so that the check for 
1463
            # already merged can operate on the just fetched graph, which will
1464
            # be cached in memory.
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1465
            self.fetch(other, stop_revision)
3052.5.2 by John Arbash Meinel
Use a Graph.heads() check to determine if the ancestries are compatible.
1466
            # Check to see if one is an ancestor of the other
3052.5.4 by John Arbash Meinel
If we are going to overwrite the target, we don't have to do
1467
            if not overwrite:
1468
                heads = self.repository.get_graph().heads([stop_revision,
1469
                                                           last_rev])
1470
                if heads == set([last_rev]):
1471
                    # The current revision is a decendent of the target,
1472
                    # nothing to do
1473
                    return
1474
                elif heads == set([stop_revision, last_rev]):
1475
                    # These branches have diverged
1476
                    raise errors.DivergedBranches(self, other)
1477
                assert heads == set([stop_revision])
3052.5.1 by John Arbash Meinel
(bug #172970) Change Branch.pull to need to generate_history less often.
1478
            if other_last_revision == stop_revision:
1479
                self.set_last_revision_info(other_last_revno,
1480
                                            other_last_revision)
1481
            else:
1482
                # TODO: jam 2007-11-29 Is there a way to determine the
1483
                #       revno without searching all of history??
3052.5.4 by John Arbash Meinel
If we are going to overwrite the target, we don't have to do
1484
                if overwrite:
1485
                    self.generate_revision_history(stop_revision)
1486
                else:
1487
                    self.generate_revision_history(stop_revision,
1488
                        last_rev=last_rev, other_branch=other)
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1489
        finally:
1490
            other.unlock()
1185.12.44 by abentley
Restored branch convergence to bzr pull
1491
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
1492
    def basis_tree(self):
1493
        """See Branch.basis_tree."""
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
1494
        return self.repository.revision_tree(self.last_revision())
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
1495
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1496
    @needs_write_lock
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1497
    def pull(self, source, overwrite=False, stop_revision=None,
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
1498
             _hook_master=None, run_hooks=True, possible_transports=None):
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1499
        """See Branch.pull.
1500
1501
        :param _hook_master: Private parameter - set the branch to 
1502
            be supplied as the master to push hooks.
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1503
        :param run_hooks: Private parameter - if false, this branch
1504
            is being called because it's the master of the primary branch,
1505
            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
1506
        """
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
1507
        result = PullResult()
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
1508
        result.source_branch = source
1509
        result.target_branch = self
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1510
        source.lock_read()
1511
        try:
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
1512
            result.old_revno, result.old_revid = self.last_revision_info()
3052.5.4 by John Arbash Meinel
If we are going to overwrite the target, we don't have to do
1513
            self.update_revisions(source, stop_revision, overwrite=overwrite)
2804.3.1 by Lukáš Lalinský
Overwrite conflicting tags by push|pull --overwrite.
1514
            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.
1515
            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.
1516
            if _hook_master:
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
1517
                result.master_branch = _hook_master
1518
                result.local_branch = self
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
1519
            else:
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
1520
                result.master_branch = self
1521
                result.local_branch = None
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1522
            if run_hooks:
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1523
                for hook in Branch.hooks['post_pull']:
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
1524
                    hook(result)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1525
        finally:
1526
            source.unlock()
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
1527
        return result
1 by mbp at sourcefrog
import from baz patch-364
1528
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
1529
    def _get_parent_location(self):
1530
        _locs = ['parent', 'pull', 'x-pull']
1531
        for l in _locs:
1532
            try:
1533
                return self.control_files.get(l).read().strip('\n')
3236.1.2 by Michael Hudson
clean up branch.py imports
1534
            except errors.NoSuchFile:
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
1535
                pass
1536
        return None
1537
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1538
    @needs_read_lock
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1539
    def push(self, target, overwrite=False, stop_revision=None,
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
1540
             _override_hook_source_branch=None):
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1541
        """See Branch.push.
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1542
1543
        This is the basic concrete implementation of push()
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
1544
1545
        :param _override_hook_source_branch: If specified, run
1546
        the hooks passing this Branch as the source, rather than self.  
1547
        This is for use of RemoteBranch, where push is delegated to the
1548
        underlying vfs-based Branch. 
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1549
        """
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1550
        # TODO: Public option to disable running hooks - should be trivial but
1551
        # needs tests.
1552
        target.lock_write()
1553
        try:
1554
            result = self._push_with_bound_branches(target, overwrite,
1555
                    stop_revision,
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
1556
                    _override_hook_source_branch=_override_hook_source_branch)
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1557
            return result
1558
        finally:
1559
            target.unlock()
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1560
1561
    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
1562
            stop_revision,
1563
            _override_hook_source_branch=None):
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
1564
        """Push from self into target, and into target's master if any.
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1565
        
1566
        This is on the base BzrBranch class even though it doesn't support 
1567
        bound branches because the *target* might be bound.
1568
        """
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
1569
        def _run_hooks():
1570
            if _override_hook_source_branch:
1571
                result.source_branch = _override_hook_source_branch
1572
            for hook in Branch.hooks['post_push']:
1573
                hook(result)
1574
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1575
        bound_location = target.get_bound_location()
1576
        if bound_location and target.base != bound_location:
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
1577
            # there is a master branch.
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1578
            #
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
1579
            # XXX: Why the second check?  Is it even supported for a branch to
1580
            # be bound to itself? -- mbp 20070507
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1581
            master_branch = target.get_master_branch()
1582
            master_branch.lock_write()
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1583
            try:
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1584
                # push into the master from this branch.
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1585
                self._basic_push(master_branch, overwrite, stop_revision)
1586
                # and push into the target branch from this. Note that we push from
1587
                # this branch again, because its considered the highest bandwidth
1588
                # repository.
1589
                result = self._basic_push(target, overwrite, stop_revision)
1590
                result.master_branch = master_branch
1591
                result.local_branch = target
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
1592
                _run_hooks()
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1593
                return result
1594
            finally:
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1595
                master_branch.unlock()
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1596
        else:
1597
            # no master branch
1598
            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
1599
            # TODO: Why set master_branch and local_branch if there's no
1600
            # binding?  Maybe cleaner to just leave them unset? -- mbp
1601
            # 20070504
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1602
            result.master_branch = target
1603
            result.local_branch = None
2477.1.5 by Martin Pool
More cleanups of Branch.push to get the right behaviour with RemoteBranches
1604
            _run_hooks()
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1605
            return result
1606
1607
    def _basic_push(self, target, overwrite, stop_revision):
1608
        """Basic implementation of push without bound branches or hooks.
1609
1610
        Must be called with self read locked and target write locked.
1611
        """
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
1612
        result = PushResult()
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
1613
        result.source_branch = self
1614
        result.target_branch = target
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1615
        result.old_revno, result.old_revid = target.last_revision_info()
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1616
        try:
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1617
            target.update_revisions(self, stop_revision)
3236.1.2 by Michael Hudson
clean up branch.py imports
1618
        except errors.DivergedBranches:
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1619
            if not overwrite:
1620
                raise
1621
        if overwrite:
1622
            target.set_revision_history(self.revision_history())
2804.3.1 by Lukáš Lalinský
Overwrite conflicting tags by push|pull --overwrite.
1623
        result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2477.1.3 by Martin Pool
More refactoring of Branch.push into smaller bits
1624
        result.new_revno, result.new_revid = target.last_revision_info()
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
1625
        return result
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1626
1149 by Martin Pool
- make get_parent() be a method of Branch; add simple tests for it
1627
    def get_parent(self):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1628
        """See Branch.get_parent."""
1773.4.3 by Martin Pool
[merge] bzr.dev
1629
1685.1.70 by Wouter van Heyst
working on get_parent, set_parent and relative urls, broken
1630
        assert self.base[-1] == '/'
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
1631
        parent = self._get_parent_location()
1632
        if parent is None:
1633
            return parent
1634
        # This is an old-format absolute path to a local branch
1635
        # turn it into a url
1636
        if parent.startswith('/'):
1637
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1638
        try:
1639
            return urlutils.join(self.base[:-1], parent)
1640
        except errors.InvalidURLJoin, e:
1641
            raise errors.InaccessibleParent(parent, self.base)
1149 by Martin Pool
- make get_parent() be a method of Branch; add simple tests for it
1642
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1643
    def set_push_location(self, location):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1644
        """See Branch.set_push_location."""
2120.6.4 by James Henstridge
add support for specifying policy when storing options
1645
        self.get_config().set_user_option(
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
1646
            'push_location', location,
1647
            store=_mod_config.STORE_LOCATION_NORECURSE)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1648
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1649
    @needs_write_lock
1150 by Martin Pool
- add new Branch.set_parent and tests
1650
    def set_parent(self, url):
1495.1.2 by Jelmer Vernooij
Move some generic methods of NativeBranch to Branch.
1651
        """See Branch.set_parent."""
1150 by Martin Pool
- add new Branch.set_parent and tests
1652
        # TODO: Maybe delete old location files?
1185.65.29 by Robert Collins
Implement final review suggestions.
1653
        # URLs should never be unicode, even on the local fs,
1654
        # FIXUP this and get_parent in a future branch format bump:
1655
        # read and rewrite the file, and have the new format code read
1656
        # using .get not .get_utf8. RBC 20060125
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
1657
        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
1658
            if isinstance(url, unicode):
1659
                try: 
1660
                    url = url.encode('ascii')
1661
                except UnicodeEncodeError:
2418.5.5 by John Arbash Meinel
Add some tests and an api for revision_id_to_dotted_revno
1662
                    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
1663
                        "Urls must be 7-bit ascii, "
1664
                        "use bzrlib.urlutils.escape")
1685.1.70 by Wouter van Heyst
working on get_parent, set_parent and relative urls, broken
1665
            url = urlutils.relative_url(self.base, url)
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
1666
        self._set_parent_location(url)
1667
1668
    def _set_parent_location(self, url):
1669
        if url is None:
1670
            self.control_files._transport.delete('parent')
1671
        else:
1672
            assert isinstance(url, str)
2249.5.11 by John Arbash Meinel
Audit Branch to ensure utf8 revision ids.
1673
            self.control_files.put_bytes('parent', url + '\n')
1150 by Martin Pool
- add new Branch.set_parent and tests
1674
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1675
1676
class BzrBranch5(BzrBranch):
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
1677
    """A format 5 branch. This supports new features over plain branches.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1678
1679
    It has support for a master_branch which is the data for bound branches.
1680
    """
1681
1682
    def __init__(self,
1683
                 _format,
1684
                 _control_files,
1685
                 a_bzrdir,
1686
                 _repository):
1687
        super(BzrBranch5, self).__init__(_format=_format,
1688
                                         _control_files=_control_files,
1689
                                         a_bzrdir=a_bzrdir,
1690
                                         _repository=_repository)
1691
        
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1692
    @needs_write_lock
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1693
    def pull(self, source, overwrite=False, stop_revision=None,
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
1694
             run_hooks=True, possible_transports=None):
2477.1.9 by Martin Pool
Review cleanups from John, mostly docs
1695
        """Pull from source into self, updating my master if any.
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1696
        
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1697
        :param run_hooks: Private parameter - if false, this branch
1698
            is being called because it's the master of the primary branch,
1699
            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
1700
        """
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1701
        bound_location = self.get_bound_location()
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1702
        master_branch = None
1703
        if bound_location and source.base != bound_location:
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1704
            # not pulling from master, so we need to update master.
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
1705
            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
1706
            master_branch.lock_write()
1707
        try:
1708
            if master_branch:
1709
                # pull from source into master.
1710
                master_branch.pull(source, overwrite, stop_revision,
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1711
                    run_hooks=False)
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1712
            return super(BzrBranch5, self).pull(source, overwrite,
1713
                stop_revision, _hook_master=master_branch,
2477.1.2 by Martin Pool
Rename push/pull back to 'run_hooks' (jameinel)
1714
                run_hooks=run_hooks)
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
1715
        finally:
1716
            if master_branch:
1717
                master_branch.unlock()
2245.2.1 by Robert Collins
Split branch pushing out of branch pulling.
1718
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
1719
    def get_bound_location(self):
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
1720
        try:
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1721
            return self.control_files.get_utf8('bound').read()[:-1]
1722
        except errors.NoSuchFile:
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
1723
            return None
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
1724
1725
    @needs_read_lock
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
1726
    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
1727
        """Return the branch we are bound to.
1728
        
1729
        :return: Either a Branch, or None
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1730
1759.2.2 by Jelmer Vernooij
Revert some of my spelling fixes and fix some typos after review by Aaron.
1731
        This could memoise the branch, but if thats done
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1732
        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.
1733
        So for now we just don't memoise it.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1734
        # 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
1735
        """
1736
        bound_loc = self.get_bound_location()
1737
        if not bound_loc:
1738
            return None
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1739
        try:
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
1740
            return Branch.open(bound_loc,
1741
                               possible_transports=possible_transports)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1742
        except (errors.NotBranchError, errors.ConnectionError), e:
1743
            raise errors.BoundBranchConnectionFailure(
1744
                    self, bound_loc, e)
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
1745
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
1746
    @needs_write_lock
1747
    def set_bound_location(self, location):
1505.1.27 by John Arbash Meinel
Adding tests against an sftp branch.
1748
        """Set the target where this branch is bound to.
1749
1750
        :param location: URL to the target branch
1751
        """
1505.1.25 by John Arbash Meinel
Updated pull. Now all paths which call set_revision_history maintain the branch invariant. All tests pass.
1752
        if location:
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1753
            self.control_files.put_utf8('bound', location+'\n')
1185.64.2 by Goffredo Baroncelli
- implemented some suggestion by Robert Collins
1754
        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.
1755
            try:
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
1756
                self.control_files._transport.delete('bound')
3236.1.2 by Michael Hudson
clean up branch.py imports
1757
            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.
1758
                return False
1759
            return True
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
1760
1761
    @needs_write_lock
1762
    def bind(self, other):
1997.1.5 by Robert Collins
``Branch.bind(other_branch)`` no longer takes a write lock on the
1763
        """Bind this branch to the branch other.
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
1764
1997.1.5 by Robert Collins
``Branch.bind(other_branch)`` no longer takes a write lock on the
1765
        This does not push or pull data between the branches, though it does
1766
        check for divergence to raise an error when the branches are not
1767
        either the same, or one a prefix of the other. That behaviour may not
1768
        be useful, so that check may be removed in future.
1769
        
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
1770
        :param other: The branch to bind to
1771
        :type other: Branch
1185.64.2 by Goffredo Baroncelli
- implemented some suggestion by Robert Collins
1772
        """
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
1773
        # TODO: jam 20051230 Consider checking if the target is bound
1774
        #       It is debatable whether you should be able to bind to
1775
        #       a branch which is itself bound.
1776
        #       Committing is obviously forbidden,
1777
        #       but binding itself may not be.
1778
        #       Since we *have* to check at commit time, we don't
1779
        #       *need* to check here
1997.1.5 by Robert Collins
``Branch.bind(other_branch)`` no longer takes a write lock on the
1780
1781
        # we want to raise diverged if:
1782
        # last_rev is not in the other_last_rev history, AND
1783
        # other_last_rev is not in our history, and do it without pulling
1784
        # history around
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
1785
        self.set_bound_location(other.base)
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
1786
1505.1.5 by John Arbash Meinel
Added a test for the unbind command.
1787
    @needs_write_lock
1788
    def unbind(self):
1789
        """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.
1790
        return self.set_bound_location(None)
1185.66.8 by Aaron Bentley
Applied Jelmer's patch to make clone a branch operation
1791
1587.1.10 by Robert Collins
update updates working tree and branch together.
1792
    @needs_write_lock
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
1793
    def update(self, possible_transports=None):
1587.1.10 by Robert Collins
update updates working tree and branch together.
1794
        """Synchronise this branch with the master branch if any. 
1795
1796
        :return: None or the last_revision that was pivoted out during the
1797
                 update.
1798
        """
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
1799
        master = self.get_master_branch(possible_transports)
1587.1.10 by Robert Collins
update updates working tree and branch together.
1800
        if master is not None:
2653.2.4 by Aaron Bentley
Remove get_ancestry usage from branch
1801
            old_tip = _mod_revision.ensure_null(self.last_revision())
1587.1.10 by Robert Collins
update updates working tree and branch together.
1802
            self.pull(master, overwrite=True)
2653.2.4 by Aaron Bentley
Remove get_ancestry usage from branch
1803
            if self.repository.get_graph().is_ancestor(old_tip,
1804
                _mod_revision.ensure_null(self.last_revision())):
1587.1.10 by Robert Collins
update updates working tree and branch together.
1805
                return None
1806
            return old_tip
1807
        return None
1808
1534.4.1 by Robert Collins
Allow parameterisation of the branch initialisation for bzrlib.
1809
2230.3.1 by Aaron Bentley
Get branch6 creation working
1810
class BzrBranch6(BzrBranch5):
2230.3.2 by Aaron Bentley
Get all branch tests passing
1811
1812
    @needs_read_lock
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1813
    def last_revision_info(self):
2249.5.19 by John Arbash Meinel
Track through the new Branch6 code, and make sure revision ids are utf8
1814
        revision_string = self.control_files.get('last-revision').read()
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1815
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2249.5.19 by John Arbash Meinel
Track through the new Branch6 code, and make sure revision ids are utf8
1816
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1817
        revno = int(revno)
1818
        return revno, revision_id
1819
1820
    def _write_last_revision_info(self, revno, revision_id):
2230.3.49 by Aaron Bentley
Fix cache updating
1821
        """Simply write out the revision id, with no checks.
1822
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1823
        Use set_last_revision_info to perform this safely.
2230.3.49 by Aaron Bentley
Fix cache updating
1824
1825
        Does not update the revision_history cache.
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1826
        Intended to be called by set_last_revision_info and
1827
        _write_revision_history.
2230.3.49 by Aaron Bentley
Fix cache updating
1828
        """
3240.1.7 by Aaron Bentley
Update from review comments
1829
        assert revision_id is not None, "Use NULL_REVISION, not None"
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1830
        out_string = '%d %s\n' % (revno, revision_id)
2249.5.17 by John Arbash Meinel
[merge] bzr.dev 2293 and resolve conflicts, but still broken
1831
        self.control_files.put_bytes('last-revision', out_string)
2230.3.2 by Aaron Bentley
Get all branch tests passing
1832
2230.3.49 by Aaron Bentley
Fix cache updating
1833
    @needs_write_lock
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1834
    def set_last_revision_info(self, revno, revision_id):
3240.1.7 by Aaron Bentley
Update from review comments
1835
        revision_id = _mod_revision.ensure_null(revision_id)
2230.3.49 by Aaron Bentley
Fix cache updating
1836
        if self._get_append_revisions_only():
1837
            self._check_history_violation(revision_id)
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1838
        self._write_last_revision_info(revno, revision_id)
2375.1.6 by Andrew Bennetts
Rename _clear_cached_data to _clear_cached_state.
1839
        self._clear_cached_state()
2230.3.49 by Aaron Bentley
Fix cache updating
1840
2230.3.32 by Aaron Bentley
Implement strict history policy
1841
    def _check_history_violation(self, revision_id):
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
1842
        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
1843
        if _mod_revision.is_null(last_revision):
2230.3.32 by Aaron Bentley
Implement strict history policy
1844
            return
1845
        if last_revision not in self._lefthand_history(revision_id):
2230.3.40 by Aaron Bentley
Rename strict_revision_history to append_revisions_only
1846
            raise errors.AppendRevisionsOnlyViolation(self.base)
2230.3.32 by Aaron Bentley
Implement strict history policy
1847
2230.4.1 by Aaron Bentley
Get log as fast branch5
1848
    def _gen_revision_history(self):
2230.3.2 by Aaron Bentley
Get all branch tests passing
1849
        """Generate the revision history from last revision
1850
        """
2230.3.54 by Aaron Bentley
Move reverse history iteration to repository
1851
        history = list(self.repository.iter_reverse_revision_history(
1852
            self.last_revision()))
2230.4.1 by Aaron Bentley
Get log as fast branch5
1853
        history.reverse()
1854
        return history
2230.3.2 by Aaron Bentley
Get all branch tests passing
1855
2230.3.49 by Aaron Bentley
Fix cache updating
1856
    def _write_revision_history(self, history):
1857
        """Factored out of set_revision_history.
1858
1859
        This performs the actual writing to disk, with format-specific checks.
1860
        It is intended to be called by BzrBranch5.set_revision_history.
1861
        """
2230.3.2 by Aaron Bentley
Get all branch tests passing
1862
        if len(history) == 0:
2230.3.49 by Aaron Bentley
Fix cache updating
1863
            last_revision = 'null:'
2230.3.2 by Aaron Bentley
Get all branch tests passing
1864
        else:
2230.3.44 by Aaron Bentley
Change asserts to specific errors for left-hand history violations
1865
            if history != self._lefthand_history(history[-1]):
1866
                raise errors.NotLefthandHistory(history)
2230.3.49 by Aaron Bentley
Fix cache updating
1867
            last_revision = history[-1]
1868
        if self._get_append_revisions_only():
1869
            self._check_history_violation(last_revision)
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1870
        self._write_last_revision_info(len(history), last_revision)
2230.3.1 by Aaron Bentley
Get branch6 creation working
1871
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
1872
    @needs_write_lock
1873
    def _set_parent_location(self, url):
1874
        """Set the parent branch"""
1875
        self._set_config_location('parent_location', url, make_relative=True)
2230.3.3 by Aaron Bentley
Add more config testing
1876
1877
    @needs_read_lock
2230.3.8 by Aaron Bentley
Abstract mechanism from policy getting/setting parents
1878
    def _get_parent_location(self):
2230.3.3 by Aaron Bentley
Add more config testing
1879
        """Set the parent branch"""
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
1880
        return self._get_config_location('parent_location')
2230.3.3 by Aaron Bentley
Add more config testing
1881
1882
    def set_push_location(self, location):
1883
        """See Branch.set_push_location."""
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
1884
        self._set_config_location('push_location', location)
2230.3.3 by Aaron Bentley
Add more config testing
1885
1886
    def set_bound_location(self, location):
1887
        """See Branch.set_push_location."""
2230.3.7 by Aaron Bentley
Fix binding return values
1888
        result = None
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
1889
        config = self.get_config()
2230.3.6 by Aaron Bentley
work in progress bind stuff
1890
        if location is None:
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
1891
            if config.get_user_option('bound') != 'True':
2230.3.7 by Aaron Bentley
Fix binding return values
1892
                return False
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
1893
            else:
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
1894
                config.set_user_option('bound', 'False', warn_masked=True)
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
1895
                return True
1896
        else:
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
1897
            self._set_config_location('bound_location', location,
1898
                                      config=config)
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
1899
            config.set_user_option('bound', 'True', warn_masked=True)
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
1900
        return True
1901
1902
    def _get_bound_location(self, bound):
1903
        """Return the bound location in the config file.
1904
1905
        Return None if the bound parameter does not match"""
1906
        config = self.get_config()
1907
        config_bound = (config.get_user_option('bound') == 'True')
1908
        if config_bound != bound:
1909
            return None
2230.3.36 by Aaron Bentley
Refactor getting/setting locations with config
1910
        return self._get_config_location('bound_location', config=config)
2230.3.3 by Aaron Bentley
Add more config testing
1911
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
1912
    def get_bound_location(self):
1913
        """See Branch.set_push_location."""
1914
        return self._get_bound_location(True)
1915
1916
    def get_old_bound_location(self):
1917
        """See Branch.get_old_bound_location"""
1918
        return self._get_bound_location(False)
1919
2230.3.40 by Aaron Bentley
Rename strict_revision_history to append_revisions_only
1920
    def set_append_revisions_only(self, enabled):
1921
        if enabled:
2230.3.32 by Aaron Bentley
Implement strict history policy
1922
            value = 'True'
1923
        else:
1924
            value = 'False'
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
1925
        self.get_config().set_user_option('append_revisions_only', value,
1926
            warn_masked=True)
2230.3.32 by Aaron Bentley
Implement strict history policy
1927
2230.3.40 by Aaron Bentley
Rename strict_revision_history to append_revisions_only
1928
    def _get_append_revisions_only(self):
1929
        value = self.get_config().get_user_option('append_revisions_only')
1930
        return value == 'True'
2230.3.32 by Aaron Bentley
Implement strict history policy
1931
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
1932
    def _synchronize_history(self, destination, revision_id):
2230.3.35 by Aaron Bentley
Add documentation for synchonize_history
1933
        """Synchronize last revision and revision history between branches.
1934
1935
        This version is most efficient when the destination is also a
1936
        BzrBranch6, but works for BzrBranch5, as long as the destination's
1937
        repository contains all the lefthand ancestors of the intended
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1938
        last_revision.  If not, set_last_revision_info will fail.
2230.3.35 by Aaron Bentley
Add documentation for synchonize_history
1939
1940
        :param destination: The branch to copy the history into
1941
        :param revision_id: The revision-id to truncate history at.  May
1942
          be None to copy complete history.
1943
        """
2697.2.3 by Martin Pool
More append_revision cleanup; _synchronize_history optimization
1944
        source_revno, source_revision_id = self.last_revision_info()
2230.3.18 by Aaron Bentley
Handle history sync as a special operation
1945
        if revision_id is None:
2697.2.3 by Martin Pool
More append_revision cleanup; _synchronize_history optimization
1946
            revno, revision_id = source_revno, source_revision_id
1947
        elif source_revision_id == revision_id:
1948
            # we know the revno without needing to walk all of history
1949
            revno = source_revno
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1950
        else:
2592.3.155 by Robert Collins
Remove some spurious differences with bzr.dev.
1951
            # To figure out the revno for a random revision, we need to build
1952
            # the revision history, and count its length.
1953
            # We don't care about the order, just how long it is.
1954
            # Alternatively, we could start at the current location, and count
1955
            # backwards. But there is no guarantee that we will find it since
1956
            # it may be a merged revision.
1957
            revno = len(list(self.repository.iter_reverse_revision_history(
1958
                                                                revision_id)))
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
1959
        destination.set_last_revision_info(revno, revision_id)
2230.3.1 by Aaron Bentley
Get branch6 creation working
1960
2220.2.27 by Martin Pool
Start adding tags to Branch6
1961
    def _make_tags(self):
1962
        return BasicTags(self)
1963
3240.1.2 by Aaron Bentley
Add write lock
1964
    @needs_write_lock
3240.1.1 by Aaron Bentley
Avoid doing Branch._lefthand_history twice
1965
    def generate_revision_history(self, revision_id, last_rev=None,
1966
                                  other_branch=None):
3240.1.6 by Aaron Bentley
Update docs
1967
        """See BzrBranch5.generate_revision_history"""
3240.1.1 by Aaron Bentley
Avoid doing Branch._lefthand_history twice
1968
        history = self._lefthand_history(revision_id, last_rev, other_branch)
1969
        revno = len(history)
1970
        self.set_last_revision_info(revno, revision_id)
1971
2230.3.34 by Aaron Bentley
cleanup
1972
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
1973
######################################################################
1974
# results of operations
1975
2220.2.37 by Martin Pool
Report conflicting tags from push.
1976
1977
class _Result(object):
1978
1979
    def _show_tag_conficts(self, to_file):
1980
        if not getattr(self, 'tag_conflicts', None):
1981
            return
1982
        to_file.write('Conflicting tags:\n')
1983
        for name, value1, value2 in self.tag_conflicts:
1984
            to_file.write('    %s\n' % (name, ))
1985
1986
1987
class PullResult(_Result):
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
1988
    """Result of a Branch.pull operation.
1989
1990
    :ivar old_revno: Revision number before pull.
1991
    :ivar new_revno: Revision number after pull.
1992
    :ivar old_revid: Tip revision id before pull.
1993
    :ivar new_revid: Tip revision id after pull.
1994
    :ivar source_branch: Source (local) branch object.
1995
    :ivar master_branch: Master branch of the target, or None.
1996
    :ivar target_branch: Target/destination branch object.
1997
    """
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
1998
2297.1.3 by Martin Pool
PullResult can pretend to be an int for api compatibility with old .pull()
1999
    def __int__(self):
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
2000
        # DEPRECATED: pull used to return the change in revno
2001
        return self.new_revno - self.old_revno
2002
2220.2.39 by Martin Pool
Pull also merges tags and warns if they conflict
2003
    def report(self, to_file):
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
2004
        if not is_quiet():
2005
            if self.old_revid == self.new_revid:
2006
                to_file.write('No revisions to pull.\n')
2007
            else:
2008
                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
2009
        self._show_tag_conficts(to_file)
2010
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
2011
2220.2.37 by Martin Pool
Report conflicting tags from push.
2012
class PushResult(_Result):
2297.1.6 by Martin Pool
Add docs for Results, give some members cleaner names
2013
    """Result of a Branch.push operation.
2014
2015
    :ivar old_revno: Revision number before push.
2016
    :ivar new_revno: Revision number after push.
2017
    :ivar old_revid: Tip revision id before push.
2018
    :ivar new_revid: Tip revision id after push.
2019
    :ivar source_branch: Source branch object.
2020
    :ivar master_branch: Master branch of the target, or None.
2021
    :ivar target_branch: Target/destination branch object.
2022
    """
2297.1.4 by Martin Pool
Push now returns a PushResult rather than just an integer.
2023
2024
    def __int__(self):
2025
        # 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()
2026
        return self.new_revno - self.old_revno
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2027
2220.2.37 by Martin Pool
Report conflicting tags from push.
2028
    def report(self, to_file):
2029
        """Write a human-readable description of the result."""
2030
        if self.old_revid == self.new_revid:
2031
            to_file.write('No new revisions to push.\n')
2032
        else:
2033
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2034
        self._show_tag_conficts(to_file)
2035
2297.1.1 by Martin Pool
Pull now returns a PullResult rather than just an integer.
2036
1732.2.4 by Martin Pool
Split check into Branch.check and Repository.check
2037
class BranchCheckResult(object):
2038
    """Results of checking branch consistency.
2039
2040
    :see: Branch.check
2041
    """
2042
2043
    def __init__(self, branch):
2044
        self.branch = branch
2045
2046
    def report_results(self, verbose):
2047
        """Report the check results via trace.note.
2048
        
2049
        :param verbose: Requests more detailed display of what was checked,
2050
            if any.
2051
        """
2052
        note('checked branch %s format %s',
2053
             self.branch.base,
2054
             self.branch._format)
2055
2056
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2057
class Converter5to6(object):
2058
    """Perform an in-place upgrade of format 5 to format 6"""
2059
2060
    def convert(self, branch):
2061
        # Data for 5 and 6 can peacefully coexist.
2062
        format = BzrBranchFormat6()
2063
        new_branch = format.open(branch.bzrdir, _found=True)
2064
2065
        # Copy source data into target
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
2066
        new_branch.set_last_revision_info(*branch.last_revision_info())
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2067
        new_branch.set_parent(branch.get_parent())
2068
        new_branch.set_bound_location(branch.get_bound_location())
2069
        new_branch.set_push_location(branch.get_push_location())
2070
2220.2.43 by Martin Pool
Should clear tag file when upgrading format 5 to 6 to prevent warning
2071
        # New branch has no tags by default
2072
        new_branch.tags._set_tag_dict({})
2073
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2074
        # Copying done; now update target format
2075
        new_branch.control_files.put_utf8('format',
2076
            format.get_format_string())
2077
2078
        # Clean up old files
2079
        new_branch.control_files._transport.delete('revision-history')
2080
        try:
2081
            branch.set_parent(None)
3236.1.2 by Michael Hudson
clean up branch.py imports
2082
        except errors.NoSuchFile:
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2083
            pass
2084
        branch.set_bound_location(None)