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