~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Packman
  • Date: 2012-02-27 12:16:28 UTC
  • mto: (6437.23.25 2.5)
  • mto: This revision was merged to the branch mainline in revision 6499.
  • Revision ID: martin.packman@canonical.com-20120227121628-9q8krey0u73v56k3
Get default stream for help output via ui_factory instead of using stdout directly

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import bzrlib.bzrdir
17
20
 
18
21
from cStringIO import StringIO
19
22
 
20
23
from bzrlib.lazy_import import lazy_import
21
24
lazy_import(globals(), """
22
 
from copy import deepcopy
23
 
from unittest import TestSuite
24
 
from warnings import warn
25
 
 
26
 
import bzrlib
 
25
import itertools
27
26
from bzrlib import (
28
 
        bzrdir,
29
 
        cache_utf8,
30
 
        config as _mod_config,
31
 
        errors,
32
 
        lockdir,
33
 
        lockable_files,
34
 
        osutils,
35
 
        revision as _mod_revision,
36
 
        transport,
37
 
        tree,
38
 
        tsort,
39
 
        ui,
40
 
        urlutils,
41
 
        )
42
 
from bzrlib.config import BranchConfig, TreeConfig
43
 
from bzrlib.lockable_files import LockableFiles, TransportLock
44
 
from bzrlib.tag import (
45
 
    BasicTags,
46
 
    DisabledTags,
 
27
    bzrdir,
 
28
    controldir,
 
29
    cache_utf8,
 
30
    cleanup,
 
31
    config as _mod_config,
 
32
    debug,
 
33
    errors,
 
34
    fetch,
 
35
    graph as _mod_graph,
 
36
    lockdir,
 
37
    lockable_files,
 
38
    remote,
 
39
    repository,
 
40
    revision as _mod_revision,
 
41
    rio,
 
42
    tag as _mod_tag,
 
43
    transport,
 
44
    ui,
 
45
    urlutils,
 
46
    vf_search,
47
47
    )
 
48
from bzrlib.i18n import gettext, ngettext
48
49
""")
49
50
 
50
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
51
 
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
52
 
                           HistoryMissing, InvalidRevisionId,
53
 
                           InvalidRevisionNumber, LockError, NoSuchFile,
54
 
                           NoSuchRevision, NoWorkingTree, NotVersionedError,
55
 
                           NotBranchError, UninitializableFormat,
56
 
                           UnlistableStore, UnlistableBranch,
57
 
                           )
 
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
52
# is guaranteed to be registered.
 
53
import bzrlib.bzrdir
 
54
 
 
55
from bzrlib import (
 
56
    bzrdir,
 
57
    controldir,
 
58
    )
 
59
from bzrlib.decorators import (
 
60
    needs_read_lock,
 
61
    needs_write_lock,
 
62
    only_raises,
 
63
    )
58
64
from bzrlib.hooks import Hooks
59
 
from bzrlib.symbol_versioning import (deprecated_function,
60
 
                                      deprecated_method,
61
 
                                      DEPRECATED_PARAMETER,
62
 
                                      deprecated_passed,
63
 
                                      zero_eight, zero_nine, zero_sixteen,
64
 
                                      )
65
 
from bzrlib.trace import mutter, note
66
 
 
67
 
 
68
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
71
 
 
72
 
 
73
 
# TODO: Maybe include checks for common corruption of newlines, etc?
74
 
 
75
 
# TODO: Some operations like log might retrieve the same revisions
76
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
77
 
# cache in memory to make this faster.  In general anything can be
78
 
# cached in memory between lock and unlock operations. .. nb thats
79
 
# what the transaction identity map provides
80
 
 
81
 
 
82
 
######################################################################
83
 
# branch objects
84
 
 
85
 
class Branch(object):
 
65
from bzrlib.inter import InterObject
 
66
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
67
from bzrlib import registry
 
68
from bzrlib.symbol_versioning import (
 
69
    deprecated_in,
 
70
    deprecated_method,
 
71
    )
 
72
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
 
73
 
 
74
 
 
75
class Branch(controldir.ControlComponent):
86
76
    """Branch holding a history of revisions.
87
77
 
88
 
    base
89
 
        Base directory/url of the branch.
90
 
 
91
 
    hooks: An instance of BranchHooks.
 
78
    :ivar base:
 
79
        Base directory/url of the branch; using control_url and
 
80
        control_transport is more standardized.
 
81
    :ivar hooks: An instance of BranchHooks.
 
82
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
83
        _clear_cached_state.
92
84
    """
93
85
    # this is really an instance variable - FIXME move it there
94
86
    # - RBC 20060112
95
87
    base = None
96
88
 
97
 
    # override this to set the strategy for storing tags
98
 
    def _make_tags(self):
99
 
        return DisabledTags(self)
100
 
 
101
 
    def __init__(self, *ignored, **ignored_too):
102
 
        self.tags = self._make_tags()
 
89
    @property
 
90
    def control_transport(self):
 
91
        return self._transport
 
92
 
 
93
    @property
 
94
    def user_transport(self):
 
95
        return self.bzrdir.user_transport
 
96
 
 
97
    def __init__(self, possible_transports=None):
 
98
        self.tags = self._format.make_tags(self)
103
99
        self._revision_history_cache = None
104
100
        self._revision_id_to_revno_cache = None
 
101
        self._partial_revision_id_to_revno_cache = {}
 
102
        self._partial_revision_history_cache = []
 
103
        self._tags_bytes = None
 
104
        self._last_revision_info_cache = None
 
105
        self._master_branch_cache = None
 
106
        self._merge_sorted_revisions_cache = None
 
107
        self._open_hook(possible_transports)
 
108
        hooks = Branch.hooks['open']
 
109
        for hook in hooks:
 
110
            hook(self)
 
111
 
 
112
    def _open_hook(self, possible_transports):
 
113
        """Called by init to allow simpler extension of the base class."""
 
114
 
 
115
    def _activate_fallback_location(self, url, possible_transports):
 
116
        """Activate the branch/repository from url as a fallback repository."""
 
117
        for existing_fallback_repo in self.repository._fallback_repositories:
 
118
            if existing_fallback_repo.user_url == url:
 
119
                # This fallback is already configured.  This probably only
 
120
                # happens because ControlDir.sprout is a horrible mess.  To avoid
 
121
                # confusing _unstack we don't add this a second time.
 
122
                mutter('duplicate activation of fallback %r on %r', url, self)
 
123
                return
 
124
        repo = self._get_fallback_repository(url, possible_transports)
 
125
        if repo.has_same_location(self.repository):
 
126
            raise errors.UnstackableLocationError(self.user_url, url)
 
127
        self.repository.add_fallback_repository(repo)
105
128
 
106
129
    def break_lock(self):
107
130
        """Break a lock if one is present from another instance.
117
140
        if master is not None:
118
141
            master.break_lock()
119
142
 
120
 
    @staticmethod
121
 
    @deprecated_method(zero_eight)
122
 
    def open_downlevel(base):
123
 
        """Open a branch which may be of an old format."""
124
 
        return Branch.open(base, _unsupported=True)
125
 
        
126
 
    @staticmethod
127
 
    def open(base, _unsupported=False):
 
143
    def _check_stackable_repo(self):
 
144
        if not self.repository._format.supports_external_lookups:
 
145
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
146
                self.repository.base)
 
147
 
 
148
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
149
        """Extend the partial history to include a given index
 
150
 
 
151
        If a stop_index is supplied, stop when that index has been reached.
 
152
        If a stop_revision is supplied, stop when that revision is
 
153
        encountered.  Otherwise, stop when the beginning of history is
 
154
        reached.
 
155
 
 
156
        :param stop_index: The index which should be present.  When it is
 
157
            present, history extension will stop.
 
158
        :param stop_revision: The revision id which should be present.  When
 
159
            it is encountered, history extension will stop.
 
160
        """
 
161
        if len(self._partial_revision_history_cache) == 0:
 
162
            self._partial_revision_history_cache = [self.last_revision()]
 
163
        repository._iter_for_revno(
 
164
            self.repository, self._partial_revision_history_cache,
 
165
            stop_index=stop_index, stop_revision=stop_revision)
 
166
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
 
167
            self._partial_revision_history_cache.pop()
 
168
 
 
169
    def _get_check_refs(self):
 
170
        """Get the references needed for check().
 
171
 
 
172
        See bzrlib.check.
 
173
        """
 
174
        revid = self.last_revision()
 
175
        return [('revision-existence', revid), ('lefthand-distance', revid)]
 
176
 
 
177
    @staticmethod
 
178
    def open(base, _unsupported=False, possible_transports=None):
128
179
        """Open the branch rooted at base.
129
180
 
130
181
        For instance, if the branch is at URL/.bzr/branch,
131
182
        Branch.open(URL) -> a Branch instance.
132
183
        """
133
 
        control = bzrdir.BzrDir.open(base, _unsupported)
134
 
        return control.open_branch(_unsupported)
135
 
 
136
 
    @staticmethod
137
 
    def open_containing(url):
 
184
        control = controldir.ControlDir.open(base,
 
185
            possible_transports=possible_transports, _unsupported=_unsupported)
 
186
        return control.open_branch(unsupported=_unsupported,
 
187
            possible_transports=possible_transports)
 
188
 
 
189
    @staticmethod
 
190
    def open_from_transport(transport, name=None, _unsupported=False,
 
191
            possible_transports=None):
 
192
        """Open the branch rooted at transport"""
 
193
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
 
194
        return control.open_branch(name=name, unsupported=_unsupported,
 
195
            possible_transports=possible_transports)
 
196
 
 
197
    @staticmethod
 
198
    def open_containing(url, possible_transports=None):
138
199
        """Open an existing branch which contains url.
139
 
        
 
200
 
140
201
        This probes for a branch at url, and searches upwards from there.
141
202
 
142
203
        Basically we keep looking up until we find the control directory or
143
204
        run into the root.  If there isn't one, raises NotBranchError.
144
 
        If there is one and it is either an unrecognised format or an unsupported 
 
205
        If there is one and it is either an unrecognised format or an unsupported
145
206
        format, UnknownFormatError or UnsupportedFormatError are raised.
146
207
        If there is one, it is returned, along with the unused portion of url.
147
208
        """
148
 
        control, relpath = bzrdir.BzrDir.open_containing(url)
149
 
        return control.open_branch(), relpath
150
 
 
151
 
    @staticmethod
152
 
    @deprecated_function(zero_eight)
153
 
    def initialize(base):
154
 
        """Create a new working tree and branch, rooted at 'base' (url)
155
 
 
156
 
        NOTE: This will soon be deprecated in favour of creation
157
 
        through a BzrDir.
158
 
        """
159
 
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
160
 
 
161
 
    @deprecated_function(zero_eight)
162
 
    def setup_caching(self, cache_root):
163
 
        """Subclasses that care about caching should override this, and set
164
 
        up cached stores located under cache_root.
165
 
        
166
 
        NOTE: This is unused.
167
 
        """
168
 
        pass
 
209
        control, relpath = controldir.ControlDir.open_containing(url,
 
210
                                                         possible_transports)
 
211
        branch = control.open_branch(possible_transports=possible_transports)
 
212
        return (branch, relpath)
 
213
 
 
214
    def _push_should_merge_tags(self):
 
215
        """Should _basic_push merge this branch's tags into the target?
 
216
 
 
217
        The default implementation returns False if this branch has no tags,
 
218
        and True the rest of the time.  Subclasses may override this.
 
219
        """
 
220
        return self.supports_tags() and self.tags.get_tag_dict()
169
221
 
170
222
    def get_config(self):
171
 
        return BranchConfig(self)
172
 
 
173
 
    def _get_nick(self):
174
 
        return self.get_config().get_nickname()
 
223
        """Get a bzrlib.config.BranchConfig for this Branch.
 
224
 
 
225
        This can then be used to get and set configuration options for the
 
226
        branch.
 
227
 
 
228
        :return: A bzrlib.config.BranchConfig.
 
229
        """
 
230
        return _mod_config.BranchConfig(self)
 
231
 
 
232
    def get_config_stack(self):
 
233
        """Get a bzrlib.config.BranchStack for this Branch.
 
234
 
 
235
        This can then be used to get and set configuration options for the
 
236
        branch.
 
237
 
 
238
        :return: A bzrlib.config.BranchStack.
 
239
        """
 
240
        return _mod_config.BranchStack(self)
 
241
 
 
242
    def _get_config(self):
 
243
        """Get the concrete config for just the config in this branch.
 
244
 
 
245
        This is not intended for client use; see Branch.get_config for the
 
246
        public API.
 
247
 
 
248
        Added in 1.14.
 
249
 
 
250
        :return: An object supporting get_option and set_option.
 
251
        """
 
252
        raise NotImplementedError(self._get_config)
 
253
 
 
254
    def _get_fallback_repository(self, url, possible_transports):
 
255
        """Get the repository we fallback to at url."""
 
256
        url = urlutils.join(self.base, url)
 
257
        a_branch = Branch.open(url, possible_transports=possible_transports)
 
258
        return a_branch.repository
 
259
 
 
260
    @needs_read_lock
 
261
    def _get_tags_bytes(self):
 
262
        """Get the bytes of a serialised tags dict.
 
263
 
 
264
        Note that not all branches support tags, nor do all use the same tags
 
265
        logic: this method is specific to BasicTags. Other tag implementations
 
266
        may use the same method name and behave differently, safely, because
 
267
        of the double-dispatch via
 
268
        format.make_tags->tags_instance->get_tags_dict.
 
269
 
 
270
        :return: The bytes of the tags file.
 
271
        :seealso: Branch._set_tags_bytes.
 
272
        """
 
273
        if self._tags_bytes is None:
 
274
            self._tags_bytes = self._transport.get_bytes('tags')
 
275
        return self._tags_bytes
 
276
 
 
277
    def _get_nick(self, local=False, possible_transports=None):
 
278
        config = self.get_config()
 
279
        # explicit overrides master, but don't look for master if local is True
 
280
        if not local and not config.has_explicit_nickname():
 
281
            try:
 
282
                master = self.get_master_branch(possible_transports)
 
283
                if master and self.user_url == master.user_url:
 
284
                    raise errors.RecursiveBind(self.user_url)
 
285
                if master is not None:
 
286
                    # return the master branch value
 
287
                    return master.nick
 
288
            except errors.RecursiveBind, e:
 
289
                raise e
 
290
            except errors.BzrError, e:
 
291
                # Silently fall back to local implicit nick if the master is
 
292
                # unavailable
 
293
                mutter("Could not connect to bound branch, "
 
294
                    "falling back to local nick.\n " + str(e))
 
295
        return config.get_nickname()
175
296
 
176
297
    def _set_nick(self, nick):
177
 
        self.get_config().set_user_option('nickname', nick)
 
298
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
178
299
 
179
300
    nick = property(_get_nick, _set_nick)
180
301
 
181
302
    def is_locked(self):
182
303
        raise NotImplementedError(self.is_locked)
183
304
 
184
 
    def lock_write(self):
 
305
    def _lefthand_history(self, revision_id, last_rev=None,
 
306
                          other_branch=None):
 
307
        if 'evil' in debug.debug_flags:
 
308
            mutter_callsite(4, "_lefthand_history scales with history.")
 
309
        # stop_revision must be a descendant of last_revision
 
310
        graph = self.repository.get_graph()
 
311
        if last_rev is not None:
 
312
            if not graph.is_ancestor(last_rev, revision_id):
 
313
                # our previous tip is not merged into stop_revision
 
314
                raise errors.DivergedBranches(self, other_branch)
 
315
        # make a new revision history from the graph
 
316
        parents_map = graph.get_parent_map([revision_id])
 
317
        if revision_id not in parents_map:
 
318
            raise errors.NoSuchRevision(self, revision_id)
 
319
        current_rev_id = revision_id
 
320
        new_history = []
 
321
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
322
        # Do not include ghosts or graph origin in revision_history
 
323
        while (current_rev_id in parents_map and
 
324
               len(parents_map[current_rev_id]) > 0):
 
325
            check_not_reserved_id(current_rev_id)
 
326
            new_history.append(current_rev_id)
 
327
            current_rev_id = parents_map[current_rev_id][0]
 
328
            parents_map = graph.get_parent_map([current_rev_id])
 
329
        new_history.reverse()
 
330
        return new_history
 
331
 
 
332
    def lock_write(self, token=None):
 
333
        """Lock the branch for write operations.
 
334
 
 
335
        :param token: A token to permit reacquiring a previously held and
 
336
            preserved lock.
 
337
        :return: A BranchWriteLockResult.
 
338
        """
185
339
        raise NotImplementedError(self.lock_write)
186
340
 
187
341
    def lock_read(self):
 
342
        """Lock the branch for read operations.
 
343
 
 
344
        :return: A bzrlib.lock.LogicalLockResult.
 
345
        """
188
346
        raise NotImplementedError(self.lock_read)
189
347
 
190
348
    def unlock(self):
198
356
        raise NotImplementedError(self.get_physical_lock_status)
199
357
 
200
358
    @needs_read_lock
 
359
    def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
 
360
        """Return the revision_id for a dotted revno.
 
361
 
 
362
        :param revno: a tuple like (1,) or (1,1,2)
 
363
        :param _cache_reverse: a private parameter enabling storage
 
364
           of the reverse mapping in a top level cache. (This should
 
365
           only be done in selective circumstances as we want to
 
366
           avoid having the mapping cached multiple times.)
 
367
        :return: the revision_id
 
368
        :raises errors.NoSuchRevision: if the revno doesn't exist
 
369
        """
 
370
        rev_id = self._do_dotted_revno_to_revision_id(revno)
 
371
        if _cache_reverse:
 
372
            self._partial_revision_id_to_revno_cache[rev_id] = revno
 
373
        return rev_id
 
374
 
 
375
    def _do_dotted_revno_to_revision_id(self, revno):
 
376
        """Worker function for dotted_revno_to_revision_id.
 
377
 
 
378
        Subclasses should override this if they wish to
 
379
        provide a more efficient implementation.
 
380
        """
 
381
        if len(revno) == 1:
 
382
            return self.get_rev_id(revno[0])
 
383
        revision_id_to_revno = self.get_revision_id_to_revno_map()
 
384
        revision_ids = [revision_id for revision_id, this_revno
 
385
                        in revision_id_to_revno.iteritems()
 
386
                        if revno == this_revno]
 
387
        if len(revision_ids) == 1:
 
388
            return revision_ids[0]
 
389
        else:
 
390
            revno_str = '.'.join(map(str, revno))
 
391
            raise errors.NoSuchRevision(self, revno_str)
 
392
 
 
393
    @needs_read_lock
 
394
    def revision_id_to_dotted_revno(self, revision_id):
 
395
        """Given a revision id, return its dotted revno.
 
396
 
 
397
        :return: a tuple like (1,) or (400,1,3).
 
398
        """
 
399
        return self._do_revision_id_to_dotted_revno(revision_id)
 
400
 
 
401
    def _do_revision_id_to_dotted_revno(self, revision_id):
 
402
        """Worker function for revision_id_to_revno."""
 
403
        # Try the caches if they are loaded
 
404
        result = self._partial_revision_id_to_revno_cache.get(revision_id)
 
405
        if result is not None:
 
406
            return result
 
407
        if self._revision_id_to_revno_cache:
 
408
            result = self._revision_id_to_revno_cache.get(revision_id)
 
409
            if result is None:
 
410
                raise errors.NoSuchRevision(self, revision_id)
 
411
        # Try the mainline as it's optimised
 
412
        try:
 
413
            revno = self.revision_id_to_revno(revision_id)
 
414
            return (revno,)
 
415
        except errors.NoSuchRevision:
 
416
            # We need to load and use the full revno map after all
 
417
            result = self.get_revision_id_to_revno_map().get(revision_id)
 
418
            if result is None:
 
419
                raise errors.NoSuchRevision(self, revision_id)
 
420
        return result
 
421
 
 
422
    @needs_read_lock
201
423
    def get_revision_id_to_revno_map(self):
202
424
        """Return the revision_id => dotted revno map.
203
425
 
227
449
 
228
450
        :return: A dictionary mapping revision_id => dotted revno.
229
451
        """
230
 
        last_revision = self.last_revision()
231
 
        revision_graph = self.repository.get_revision_graph(last_revision)
232
 
        merge_sorted_revisions = tsort.merge_sort(
233
 
            revision_graph,
234
 
            last_revision,
235
 
            None,
236
 
            generate_revno=True)
237
452
        revision_id_to_revno = dict((rev_id, revno)
238
 
                                    for seq_num, rev_id, depth, revno, end_of_merge
239
 
                                     in merge_sorted_revisions)
 
453
            for rev_id, depth, revno, end_of_merge
 
454
             in self.iter_merge_sorted_revisions())
240
455
        return revision_id_to_revno
241
456
 
 
457
    @needs_read_lock
 
458
    def iter_merge_sorted_revisions(self, start_revision_id=None,
 
459
            stop_revision_id=None, stop_rule='exclude', direction='reverse'):
 
460
        """Walk the revisions for a branch in merge sorted order.
 
461
 
 
462
        Merge sorted order is the output from a merge-aware,
 
463
        topological sort, i.e. all parents come before their
 
464
        children going forward; the opposite for reverse.
 
465
 
 
466
        :param start_revision_id: the revision_id to begin walking from.
 
467
            If None, the branch tip is used.
 
468
        :param stop_revision_id: the revision_id to terminate the walk
 
469
            after. If None, the rest of history is included.
 
470
        :param stop_rule: if stop_revision_id is not None, the precise rule
 
471
            to use for termination:
 
472
 
 
473
            * 'exclude' - leave the stop revision out of the result (default)
 
474
            * 'include' - the stop revision is the last item in the result
 
475
            * 'with-merges' - include the stop revision and all of its
 
476
              merged revisions in the result
 
477
            * 'with-merges-without-common-ancestry' - filter out revisions 
 
478
              that are in both ancestries
 
479
        :param direction: either 'reverse' or 'forward':
 
480
 
 
481
            * reverse means return the start_revision_id first, i.e.
 
482
              start at the most recent revision and go backwards in history
 
483
            * forward returns tuples in the opposite order to reverse.
 
484
              Note in particular that forward does *not* do any intelligent
 
485
              ordering w.r.t. depth as some clients of this API may like.
 
486
              (If required, that ought to be done at higher layers.)
 
487
 
 
488
        :return: an iterator over (revision_id, depth, revno, end_of_merge)
 
489
            tuples where:
 
490
 
 
491
            * revision_id: the unique id of the revision
 
492
            * depth: How many levels of merging deep this node has been
 
493
              found.
 
494
            * revno_sequence: This field provides a sequence of
 
495
              revision numbers for all revisions. The format is:
 
496
              (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
 
497
              branch that the revno is on. From left to right the REVNO numbers
 
498
              are the sequence numbers within that branch of the revision.
 
499
            * end_of_merge: When True the next node (earlier in history) is
 
500
              part of a different merge.
 
501
        """
 
502
        # Note: depth and revno values are in the context of the branch so
 
503
        # we need the full graph to get stable numbers, regardless of the
 
504
        # start_revision_id.
 
505
        if self._merge_sorted_revisions_cache is None:
 
506
            last_revision = self.last_revision()
 
507
            known_graph = self.repository.get_known_graph_ancestry(
 
508
                [last_revision])
 
509
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
 
510
                last_revision)
 
511
        filtered = self._filter_merge_sorted_revisions(
 
512
            self._merge_sorted_revisions_cache, start_revision_id,
 
513
            stop_revision_id, stop_rule)
 
514
        # Make sure we don't return revisions that are not part of the
 
515
        # start_revision_id ancestry.
 
516
        filtered = self._filter_start_non_ancestors(filtered)
 
517
        if direction == 'reverse':
 
518
            return filtered
 
519
        if direction == 'forward':
 
520
            return reversed(list(filtered))
 
521
        else:
 
522
            raise ValueError('invalid direction %r' % direction)
 
523
 
 
524
    def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
 
525
        start_revision_id, stop_revision_id, stop_rule):
 
526
        """Iterate over an inclusive range of sorted revisions."""
 
527
        rev_iter = iter(merge_sorted_revisions)
 
528
        if start_revision_id is not None:
 
529
            for node in rev_iter:
 
530
                rev_id = node.key
 
531
                if rev_id != start_revision_id:
 
532
                    continue
 
533
                else:
 
534
                    # The decision to include the start or not
 
535
                    # depends on the stop_rule if a stop is provided
 
536
                    # so pop this node back into the iterator
 
537
                    rev_iter = itertools.chain(iter([node]), rev_iter)
 
538
                    break
 
539
        if stop_revision_id is None:
 
540
            # Yield everything
 
541
            for node in rev_iter:
 
542
                rev_id = node.key
 
543
                yield (rev_id, node.merge_depth, node.revno,
 
544
                       node.end_of_merge)
 
545
        elif stop_rule == 'exclude':
 
546
            for node in rev_iter:
 
547
                rev_id = node.key
 
548
                if rev_id == stop_revision_id:
 
549
                    return
 
550
                yield (rev_id, node.merge_depth, node.revno,
 
551
                       node.end_of_merge)
 
552
        elif stop_rule == 'include':
 
553
            for node in rev_iter:
 
554
                rev_id = node.key
 
555
                yield (rev_id, node.merge_depth, node.revno,
 
556
                       node.end_of_merge)
 
557
                if rev_id == stop_revision_id:
 
558
                    return
 
559
        elif stop_rule == 'with-merges-without-common-ancestry':
 
560
            # We want to exclude all revisions that are already part of the
 
561
            # stop_revision_id ancestry.
 
562
            graph = self.repository.get_graph()
 
563
            ancestors = graph.find_unique_ancestors(start_revision_id,
 
564
                                                    [stop_revision_id])
 
565
            for node in rev_iter:
 
566
                rev_id = node.key
 
567
                if rev_id not in ancestors:
 
568
                    continue
 
569
                yield (rev_id, node.merge_depth, node.revno,
 
570
                       node.end_of_merge)
 
571
        elif stop_rule == 'with-merges':
 
572
            stop_rev = self.repository.get_revision(stop_revision_id)
 
573
            if stop_rev.parent_ids:
 
574
                left_parent = stop_rev.parent_ids[0]
 
575
            else:
 
576
                left_parent = _mod_revision.NULL_REVISION
 
577
            # left_parent is the actual revision we want to stop logging at,
 
578
            # since we want to show the merged revisions after the stop_rev too
 
579
            reached_stop_revision_id = False
 
580
            revision_id_whitelist = []
 
581
            for node in rev_iter:
 
582
                rev_id = node.key
 
583
                if rev_id == left_parent:
 
584
                    # reached the left parent after the stop_revision
 
585
                    return
 
586
                if (not reached_stop_revision_id or
 
587
                        rev_id in revision_id_whitelist):
 
588
                    yield (rev_id, node.merge_depth, node.revno,
 
589
                       node.end_of_merge)
 
590
                    if reached_stop_revision_id or rev_id == stop_revision_id:
 
591
                        # only do the merged revs of rev_id from now on
 
592
                        rev = self.repository.get_revision(rev_id)
 
593
                        if rev.parent_ids:
 
594
                            reached_stop_revision_id = True
 
595
                            revision_id_whitelist.extend(rev.parent_ids)
 
596
        else:
 
597
            raise ValueError('invalid stop_rule %r' % stop_rule)
 
598
 
 
599
    def _filter_start_non_ancestors(self, rev_iter):
 
600
        # If we started from a dotted revno, we want to consider it as a tip
 
601
        # and don't want to yield revisions that are not part of its
 
602
        # ancestry. Given the order guaranteed by the merge sort, we will see
 
603
        # uninteresting descendants of the first parent of our tip before the
 
604
        # tip itself.
 
605
        first = rev_iter.next()
 
606
        (rev_id, merge_depth, revno, end_of_merge) = first
 
607
        yield first
 
608
        if not merge_depth:
 
609
            # We start at a mainline revision so by definition, all others
 
610
            # revisions in rev_iter are ancestors
 
611
            for node in rev_iter:
 
612
                yield node
 
613
 
 
614
        clean = False
 
615
        whitelist = set()
 
616
        pmap = self.repository.get_parent_map([rev_id])
 
617
        parents = pmap.get(rev_id, [])
 
618
        if parents:
 
619
            whitelist.update(parents)
 
620
        else:
 
621
            # If there is no parents, there is nothing of interest left
 
622
 
 
623
            # FIXME: It's hard to test this scenario here as this code is never
 
624
            # called in that case. -- vila 20100322
 
625
            return
 
626
 
 
627
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
 
628
            if not clean:
 
629
                if rev_id in whitelist:
 
630
                    pmap = self.repository.get_parent_map([rev_id])
 
631
                    parents = pmap.get(rev_id, [])
 
632
                    whitelist.remove(rev_id)
 
633
                    whitelist.update(parents)
 
634
                    if merge_depth == 0:
 
635
                        # We've reached the mainline, there is nothing left to
 
636
                        # filter
 
637
                        clean = True
 
638
                else:
 
639
                    # A revision that is not part of the ancestry of our
 
640
                    # starting revision.
 
641
                    continue
 
642
            yield (rev_id, merge_depth, revno, end_of_merge)
 
643
 
242
644
    def leave_lock_in_place(self):
243
645
        """Tell this branch object not to release the physical lock when this
244
646
        object is unlocked.
245
 
        
 
647
 
246
648
        If lock_write doesn't return a token, then this method is not supported.
247
649
        """
248
650
        self.control_files.leave_in_place()
255
657
        """
256
658
        self.control_files.dont_leave_in_place()
257
659
 
258
 
    def abspath(self, name):
259
 
        """Return absolute filename for something in the branch
260
 
        
261
 
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
262
 
        method and not a tree method.
263
 
        """
264
 
        raise NotImplementedError(self.abspath)
265
 
 
266
660
    def bind(self, other):
267
661
        """Bind the local branch the other branch.
268
662
 
269
663
        :param other: The branch to bind to
270
664
        :type other: Branch
271
665
        """
272
 
        raise errors.UpgradeRequired(self.base)
 
666
        raise errors.UpgradeRequired(self.user_url)
 
667
 
 
668
    def get_append_revisions_only(self):
 
669
        """Whether it is only possible to append revisions to the history.
 
670
        """
 
671
        if not self._format.supports_set_append_revisions_only():
 
672
            return False
 
673
        return self.get_config_stack().get('append_revisions_only')
 
674
 
 
675
    def set_append_revisions_only(self, enabled):
 
676
        if not self._format.supports_set_append_revisions_only():
 
677
            raise errors.UpgradeRequired(self.user_url)
 
678
        self.get_config_stack().set('append_revisions_only', enabled)
 
679
 
 
680
    def set_reference_info(self, file_id, tree_path, branch_location):
 
681
        """Set the branch location to use for a tree reference."""
 
682
        raise errors.UnsupportedOperation(self.set_reference_info, self)
 
683
 
 
684
    def get_reference_info(self, file_id):
 
685
        """Get the tree_path and branch_location for a tree reference."""
 
686
        raise errors.UnsupportedOperation(self.get_reference_info, self)
273
687
 
274
688
    @needs_write_lock
275
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
689
    def fetch(self, from_branch, last_revision=None, limit=None):
276
690
        """Copy revisions from from_branch into this branch.
277
691
 
278
692
        :param from_branch: Where to copy from.
279
693
        :param last_revision: What revision to stop at (None for at the end
280
694
                              of the branch.
281
 
        :param pb: An optional progress bar to use.
282
 
 
283
 
        Returns the copied revision count and the failed revisions in a tuple:
284
 
        (copied, failures).
 
695
        :param limit: Optional rough limit of revisions to fetch
 
696
        :return: None
285
697
        """
286
 
        if self.base == from_branch.base:
287
 
            return (0, [])
288
 
        if pb is None:
289
 
            nested_pb = ui.ui_factory.nested_progress_bar()
290
 
            pb = nested_pb
291
 
        else:
292
 
            nested_pb = None
293
 
 
294
 
        from_branch.lock_read()
295
 
        try:
296
 
            if last_revision is None:
297
 
                pb.update('get source history')
298
 
                last_revision = from_branch.last_revision()
299
 
                if last_revision is None:
300
 
                    last_revision = _mod_revision.NULL_REVISION
301
 
            return self.repository.fetch(from_branch.repository,
302
 
                                         revision_id=last_revision,
303
 
                                         pb=nested_pb)
304
 
        finally:
305
 
            if nested_pb is not None:
306
 
                nested_pb.finished()
307
 
            from_branch.unlock()
 
698
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
308
699
 
309
700
    def get_bound_location(self):
310
701
        """Return the URL of the branch we are bound to.
313
704
        branch.
314
705
        """
315
706
        return None
316
 
    
 
707
 
317
708
    def get_old_bound_location(self):
318
709
        """Return the URL of the branch we used to be bound to
319
710
        """
320
 
        raise errors.UpgradeRequired(self.base)
 
711
        raise errors.UpgradeRequired(self.user_url)
321
712
 
322
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
323
 
                           timezone=None, committer=None, revprops=None, 
324
 
                           revision_id=None):
 
713
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
 
714
                           timezone=None, committer=None, revprops=None,
 
715
                           revision_id=None, lossy=False):
325
716
        """Obtain a CommitBuilder for this branch.
326
 
        
 
717
 
327
718
        :param parents: Revision ids of the parents of the new revision.
328
719
        :param config: Optional configuration to use.
329
720
        :param timestamp: Optional timestamp recorded for commit.
331
722
        :param committer: Optional committer to set for commit.
332
723
        :param revprops: Optional dictionary of revision properties.
333
724
        :param revision_id: Optional revision id.
 
725
        :param lossy: Whether to discard data that can not be natively
 
726
            represented, when pushing to a foreign VCS 
334
727
        """
335
728
 
336
 
        if config is None:
337
 
            config = self.get_config()
338
 
        
339
 
        return self.repository.get_commit_builder(self, parents, config,
340
 
            timestamp, timezone, committer, revprops, revision_id)
341
 
 
342
 
    def get_master_branch(self):
 
729
        if config_stack is None:
 
730
            config_stack = self.get_config_stack()
 
731
 
 
732
        return self.repository.get_commit_builder(self, parents, config_stack,
 
733
            timestamp, timezone, committer, revprops, revision_id,
 
734
            lossy)
 
735
 
 
736
    def get_master_branch(self, possible_transports=None):
343
737
        """Return the branch we are bound to.
344
 
        
 
738
 
345
739
        :return: Either a Branch, or None
346
740
        """
347
741
        return None
348
742
 
 
743
    @deprecated_method(deprecated_in((2, 5, 0)))
349
744
    def get_revision_delta(self, revno):
350
745
        """Return the delta for one revision.
351
746
 
352
747
        The delta is relative to its mainline predecessor, or the
353
748
        empty tree for revision 1.
354
749
        """
355
 
        assert isinstance(revno, int)
356
 
        rh = self.revision_history()
357
 
        if not (1 <= revno <= len(rh)):
358
 
            raise InvalidRevisionNumber(revno)
359
 
        return self.repository.get_revision_delta(rh[revno-1])
360
 
 
361
 
    @deprecated_method(zero_sixteen)
362
 
    def get_root_id(self):
363
 
        """Return the id of this branches root
364
 
 
365
 
        Deprecated: branches don't have root ids-- trees do.
366
 
        Use basis_tree().get_root_id() instead.
 
750
        try:
 
751
            revid = self.get_rev_id(revno)
 
752
        except errors.NoSuchRevision:
 
753
            raise errors.InvalidRevisionNumber(revno)
 
754
        return self.repository.get_revision_delta(revid)
 
755
 
 
756
    def get_stacked_on_url(self):
 
757
        """Get the URL this branch is stacked against.
 
758
 
 
759
        :raises NotStacked: If the branch is not stacked.
 
760
        :raises UnstackableBranchFormat: If the branch does not support
 
761
            stacking.
367
762
        """
368
 
        raise NotImplementedError(self.get_root_id)
 
763
        raise NotImplementedError(self.get_stacked_on_url)
369
764
 
370
765
    def print_file(self, file, revision_id):
371
766
        """Print `file` to stdout."""
372
767
        raise NotImplementedError(self.print_file)
373
768
 
374
 
    def append_revision(self, *revision_ids):
375
 
        raise NotImplementedError(self.append_revision)
376
 
 
 
769
    @deprecated_method(deprecated_in((2, 4, 0)))
377
770
    def set_revision_history(self, rev_history):
378
 
        raise NotImplementedError(self.set_revision_history)
 
771
        """See Branch.set_revision_history."""
 
772
        self._set_revision_history(rev_history)
 
773
 
 
774
    @needs_write_lock
 
775
    def _set_revision_history(self, rev_history):
 
776
        if len(rev_history) == 0:
 
777
            revid = _mod_revision.NULL_REVISION
 
778
        else:
 
779
            revid = rev_history[-1]
 
780
        if rev_history != self._lefthand_history(revid):
 
781
            raise errors.NotLefthandHistory(rev_history)
 
782
        self.set_last_revision_info(len(rev_history), revid)
 
783
        self._cache_revision_history(rev_history)
 
784
        for hook in Branch.hooks['set_rh']:
 
785
            hook(self, rev_history)
 
786
 
 
787
    @needs_write_lock
 
788
    def set_last_revision_info(self, revno, revision_id):
 
789
        """Set the last revision of this branch.
 
790
 
 
791
        The caller is responsible for checking that the revno is correct
 
792
        for this revision id.
 
793
 
 
794
        It may be possible to set the branch last revision to an id not
 
795
        present in the repository.  However, branches can also be
 
796
        configured to check constraints on history, in which case this may not
 
797
        be permitted.
 
798
        """
 
799
        raise NotImplementedError(self.set_last_revision_info)
 
800
 
 
801
    @needs_write_lock
 
802
    def generate_revision_history(self, revision_id, last_rev=None,
 
803
                                  other_branch=None):
 
804
        """See Branch.generate_revision_history"""
 
805
        graph = self.repository.get_graph()
 
806
        (last_revno, last_revid) = self.last_revision_info()
 
807
        known_revision_ids = [
 
808
            (last_revid, last_revno),
 
809
            (_mod_revision.NULL_REVISION, 0),
 
810
            ]
 
811
        if last_rev is not None:
 
812
            if not graph.is_ancestor(last_rev, revision_id):
 
813
                # our previous tip is not merged into stop_revision
 
814
                raise errors.DivergedBranches(self, other_branch)
 
815
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
816
        self.set_last_revision_info(revno, revision_id)
 
817
 
 
818
    @needs_write_lock
 
819
    def set_parent(self, url):
 
820
        """See Branch.set_parent."""
 
821
        # TODO: Maybe delete old location files?
 
822
        # URLs should never be unicode, even on the local fs,
 
823
        # FIXUP this and get_parent in a future branch format bump:
 
824
        # read and rewrite the file. RBC 20060125
 
825
        if url is not None:
 
826
            if isinstance(url, unicode):
 
827
                try:
 
828
                    url = url.encode('ascii')
 
829
                except UnicodeEncodeError:
 
830
                    raise errors.InvalidURL(url,
 
831
                        "Urls must be 7-bit ascii, "
 
832
                        "use bzrlib.urlutils.escape")
 
833
            url = urlutils.relative_url(self.base, url)
 
834
        self._set_parent_location(url)
 
835
 
 
836
    @needs_write_lock
 
837
    def set_stacked_on_url(self, url):
 
838
        """Set the URL this branch is stacked against.
 
839
 
 
840
        :raises UnstackableBranchFormat: If the branch does not support
 
841
            stacking.
 
842
        :raises UnstackableRepositoryFormat: If the repository does not support
 
843
            stacking.
 
844
        """
 
845
        if not self._format.supports_stacking():
 
846
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
847
        # XXX: Changing from one fallback repository to another does not check
 
848
        # that all the data you need is present in the new fallback.
 
849
        # Possibly it should.
 
850
        self._check_stackable_repo()
 
851
        if not url:
 
852
            try:
 
853
                old_url = self.get_stacked_on_url()
 
854
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
855
                errors.UnstackableRepositoryFormat):
 
856
                return
 
857
            self._unstack()
 
858
        else:
 
859
            self._activate_fallback_location(url,
 
860
                possible_transports=[self.bzrdir.root_transport])
 
861
        # write this out after the repository is stacked to avoid setting a
 
862
        # stacked config that doesn't work.
 
863
        self._set_config_location('stacked_on_location', url)
 
864
 
 
865
    def _unstack(self):
 
866
        """Change a branch to be unstacked, copying data as needed.
 
867
 
 
868
        Don't call this directly, use set_stacked_on_url(None).
 
869
        """
 
870
        pb = ui.ui_factory.nested_progress_bar()
 
871
        try:
 
872
            pb.update(gettext("Unstacking"))
 
873
            # The basic approach here is to fetch the tip of the branch,
 
874
            # including all available ghosts, from the existing stacked
 
875
            # repository into a new repository object without the fallbacks. 
 
876
            #
 
877
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
 
878
            # correct for CHKMap repostiories
 
879
            old_repository = self.repository
 
880
            if len(old_repository._fallback_repositories) != 1:
 
881
                raise AssertionError("can't cope with fallback repositories "
 
882
                    "of %r (fallbacks: %r)" % (old_repository,
 
883
                        old_repository._fallback_repositories))
 
884
            # Open the new repository object.
 
885
            # Repositories don't offer an interface to remove fallback
 
886
            # repositories today; take the conceptually simpler option and just
 
887
            # reopen it.  We reopen it starting from the URL so that we
 
888
            # get a separate connection for RemoteRepositories and can
 
889
            # stream from one of them to the other.  This does mean doing
 
890
            # separate SSH connection setup, but unstacking is not a
 
891
            # common operation so it's tolerable.
 
892
            new_bzrdir = controldir.ControlDir.open(
 
893
                self.bzrdir.root_transport.base)
 
894
            new_repository = new_bzrdir.find_repository()
 
895
            if new_repository._fallback_repositories:
 
896
                raise AssertionError("didn't expect %r to have "
 
897
                    "fallback_repositories"
 
898
                    % (self.repository,))
 
899
            # Replace self.repository with the new repository.
 
900
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
901
            # lock count) of self.repository to the new repository.
 
902
            lock_token = old_repository.lock_write().repository_token
 
903
            self.repository = new_repository
 
904
            if isinstance(self, remote.RemoteBranch):
 
905
                # Remote branches can have a second reference to the old
 
906
                # repository that need to be replaced.
 
907
                if self._real_branch is not None:
 
908
                    self._real_branch.repository = new_repository
 
909
            self.repository.lock_write(token=lock_token)
 
910
            if lock_token is not None:
 
911
                old_repository.leave_lock_in_place()
 
912
            old_repository.unlock()
 
913
            if lock_token is not None:
 
914
                # XXX: self.repository.leave_lock_in_place() before this
 
915
                # function will not be preserved.  Fortunately that doesn't
 
916
                # affect the current default format (2a), and would be a
 
917
                # corner-case anyway.
 
918
                #  - Andrew Bennetts, 2010/06/30
 
919
                self.repository.dont_leave_lock_in_place()
 
920
            old_lock_count = 0
 
921
            while True:
 
922
                try:
 
923
                    old_repository.unlock()
 
924
                except errors.LockNotHeld:
 
925
                    break
 
926
                old_lock_count += 1
 
927
            if old_lock_count == 0:
 
928
                raise AssertionError(
 
929
                    'old_repository should have been locked at least once.')
 
930
            for i in range(old_lock_count-1):
 
931
                self.repository.lock_write()
 
932
            # Fetch from the old repository into the new.
 
933
            old_repository.lock_read()
 
934
            try:
 
935
                # XXX: If you unstack a branch while it has a working tree
 
936
                # with a pending merge, the pending-merged revisions will no
 
937
                # longer be present.  You can (probably) revert and remerge.
 
938
                try:
 
939
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
940
                except errors.TagsNotSupported:
 
941
                    tags_to_fetch = set()
 
942
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
 
943
                    old_repository, required_ids=[self.last_revision()],
 
944
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
945
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
 
946
            finally:
 
947
                old_repository.unlock()
 
948
        finally:
 
949
            pb.finished()
 
950
 
 
951
    def _set_tags_bytes(self, bytes):
 
952
        """Mirror method for _get_tags_bytes.
 
953
 
 
954
        :seealso: Branch._get_tags_bytes.
 
955
        """
 
956
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
957
        op.add_cleanup(self.lock_write().unlock)
 
958
        return op.run_simple(bytes)
 
959
 
 
960
    def _set_tags_bytes_locked(self, bytes):
 
961
        self._tags_bytes = bytes
 
962
        return self._transport.put_bytes('tags', bytes)
379
963
 
380
964
    def _cache_revision_history(self, rev_history):
381
965
        """Set the cached revision history to rev_history.
407
991
        """
408
992
        self._revision_history_cache = None
409
993
        self._revision_id_to_revno_cache = None
 
994
        self._last_revision_info_cache = None
 
995
        self._master_branch_cache = None
 
996
        self._merge_sorted_revisions_cache = None
 
997
        self._partial_revision_history_cache = []
 
998
        self._partial_revision_id_to_revno_cache = {}
 
999
        self._tags_bytes = None
410
1000
 
411
1001
    def _gen_revision_history(self):
412
1002
        """Return sequence of revision hashes on to this branch.
413
 
        
 
1003
 
414
1004
        Unlike revision_history, this method always regenerates or rereads the
415
1005
        revision history, i.e. it does not cache the result, so repeated calls
416
1006
        may be expensive.
417
1007
 
418
1008
        Concrete subclasses should override this instead of revision_history so
419
1009
        that subclasses do not need to deal with caching logic.
420
 
        
 
1010
 
421
1011
        This API is semi-public; it only for use by subclasses, all other code
422
1012
        should consider it to be private.
423
1013
        """
424
1014
        raise NotImplementedError(self._gen_revision_history)
425
1015
 
 
1016
    @deprecated_method(deprecated_in((2, 5, 0)))
426
1017
    @needs_read_lock
427
1018
    def revision_history(self):
428
 
        """Return sequence of revision hashes on to this branch.
429
 
        
 
1019
        """Return sequence of revision ids on this branch.
 
1020
 
430
1021
        This method will cache the revision history for as long as it is safe to
431
1022
        do so.
432
1023
        """
 
1024
        return self._revision_history()
 
1025
 
 
1026
    def _revision_history(self):
 
1027
        if 'evil' in debug.debug_flags:
 
1028
            mutter_callsite(3, "revision_history scales with history.")
433
1029
        if self._revision_history_cache is not None:
434
1030
            history = self._revision_history_cache
435
1031
        else:
443
1039
        That is equivalent to the number of revisions committed to
444
1040
        this branch.
445
1041
        """
446
 
        return len(self.revision_history())
 
1042
        return self.last_revision_info()[0]
447
1043
 
448
1044
    def unbind(self):
449
1045
        """Older format branches cannot bind or unbind."""
450
 
        raise errors.UpgradeRequired(self.base)
451
 
 
452
 
    def set_append_revisions_only(self, enabled):
453
 
        """Older format branches are never restricted to append-only"""
454
 
        raise errors.UpgradeRequired(self.base)
 
1046
        raise errors.UpgradeRequired(self.user_url)
455
1047
 
456
1048
    def last_revision(self):
457
 
        """Return last revision id, or None"""
458
 
        ph = self.revision_history()
459
 
        if ph:
460
 
            return ph[-1]
461
 
        else:
462
 
            return None
 
1049
        """Return last revision id, or NULL_REVISION."""
 
1050
        return self.last_revision_info()[1]
463
1051
 
 
1052
    @needs_read_lock
464
1053
    def last_revision_info(self):
465
1054
        """Return information about the last revision.
466
1055
 
467
 
        :return: A tuple (revno, last_revision_id).
468
 
        """
469
 
        rh = self.revision_history()
470
 
        revno = len(rh)
471
 
        if revno:
472
 
            return (revno, rh[-1])
473
 
        else:
474
 
            return (0, _mod_revision.NULL_REVISION)
475
 
 
476
 
    def missing_revisions(self, other, stop_revision=None):
477
 
        """Return a list of new revisions that would perfectly fit.
478
 
        
479
 
        If self and other have not diverged, return a list of the revisions
480
 
        present in other, but missing from self.
481
 
        """
482
 
        self_history = self.revision_history()
483
 
        self_len = len(self_history)
484
 
        other_history = other.revision_history()
485
 
        other_len = len(other_history)
486
 
        common_index = min(self_len, other_len) -1
487
 
        if common_index >= 0 and \
488
 
            self_history[common_index] != other_history[common_index]:
489
 
            raise DivergedBranches(self, other)
490
 
 
491
 
        if stop_revision is None:
492
 
            stop_revision = other_len
493
 
        else:
494
 
            assert isinstance(stop_revision, int)
495
 
            if stop_revision > other_len:
496
 
                raise errors.NoSuchRevision(self, stop_revision)
497
 
        return other_history[self_len:stop_revision]
498
 
 
499
 
    def update_revisions(self, other, stop_revision=None):
500
 
        """Pull in new perfect-fit revisions.
501
 
 
502
 
        :param other: Another Branch to pull from
503
 
        :param stop_revision: Updated until the given revision
504
 
        :return: None
505
 
        """
506
 
        raise NotImplementedError(self.update_revisions)
 
1056
        :return: A tuple (revno, revision_id).
 
1057
        """
 
1058
        if self._last_revision_info_cache is None:
 
1059
            self._last_revision_info_cache = self._read_last_revision_info()
 
1060
        return self._last_revision_info_cache
 
1061
 
 
1062
    def _read_last_revision_info(self):
 
1063
        raise NotImplementedError(self._read_last_revision_info)
 
1064
 
 
1065
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1066
    def import_last_revision_info(self, source_repo, revno, revid):
 
1067
        """Set the last revision info, importing from another repo if necessary.
 
1068
 
 
1069
        :param source_repo: Source repository to optionally fetch from
 
1070
        :param revno: Revision number of the new tip
 
1071
        :param revid: Revision id of the new tip
 
1072
        """
 
1073
        if not self.repository.has_same_location(source_repo):
 
1074
            self.repository.fetch(source_repo, revision_id=revid)
 
1075
        self.set_last_revision_info(revno, revid)
 
1076
 
 
1077
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1078
                                           lossy=False):
 
1079
        """Set the last revision info, importing from another repo if necessary.
 
1080
 
 
1081
        This is used by the bound branch code to upload a revision to
 
1082
        the master branch first before updating the tip of the local branch.
 
1083
        Revisions referenced by source's tags are also transferred.
 
1084
 
 
1085
        :param source: Source branch to optionally fetch from
 
1086
        :param revno: Revision number of the new tip
 
1087
        :param revid: Revision id of the new tip
 
1088
        :param lossy: Whether to discard metadata that can not be
 
1089
            natively represented
 
1090
        :return: Tuple with the new revision number and revision id
 
1091
            (should only be different from the arguments when lossy=True)
 
1092
        """
 
1093
        if not self.repository.has_same_location(source.repository):
 
1094
            self.fetch(source, revid)
 
1095
        self.set_last_revision_info(revno, revid)
 
1096
        return (revno, revid)
507
1097
 
508
1098
    def revision_id_to_revno(self, revision_id):
509
1099
        """Given a revision id, return its revno"""
510
 
        if revision_id is None:
 
1100
        if _mod_revision.is_null(revision_id):
511
1101
            return 0
512
 
        revision_id = osutils.safe_revision_id(revision_id)
513
 
        history = self.revision_history()
 
1102
        history = self._revision_history()
514
1103
        try:
515
1104
            return history.index(revision_id) + 1
516
1105
        except ValueError:
517
1106
            raise errors.NoSuchRevision(self, revision_id)
518
1107
 
 
1108
    @needs_read_lock
519
1109
    def get_rev_id(self, revno, history=None):
520
1110
        """Find the revision id of the specified revno."""
521
1111
        if revno == 0:
522
 
            return None
523
 
        if history is None:
524
 
            history = self.revision_history()
525
 
        if revno <= 0 or revno > len(history):
 
1112
            return _mod_revision.NULL_REVISION
 
1113
        last_revno, last_revid = self.last_revision_info()
 
1114
        if revno == last_revno:
 
1115
            return last_revid
 
1116
        if revno <= 0 or revno > last_revno:
526
1117
            raise errors.NoSuchRevision(self, revno)
527
 
        return history[revno - 1]
 
1118
        distance_from_last = last_revno - revno
 
1119
        if len(self._partial_revision_history_cache) <= distance_from_last:
 
1120
            self._extend_partial_history(distance_from_last)
 
1121
        return self._partial_revision_history_cache[distance_from_last]
528
1122
 
529
 
    def pull(self, source, overwrite=False, stop_revision=None):
 
1123
    def pull(self, source, overwrite=False, stop_revision=None,
 
1124
             possible_transports=None, *args, **kwargs):
530
1125
        """Mirror source into this branch.
531
1126
 
532
1127
        This branch is considered to be 'local', having low latency.
533
1128
 
534
1129
        :returns: PullResult instance
535
1130
        """
536
 
        raise NotImplementedError(self.pull)
 
1131
        return InterBranch.get(source, self).pull(overwrite=overwrite,
 
1132
            stop_revision=stop_revision,
 
1133
            possible_transports=possible_transports, *args, **kwargs)
537
1134
 
538
 
    def push(self, target, overwrite=False, stop_revision=None):
 
1135
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1136
            *args, **kwargs):
539
1137
        """Mirror this branch into target.
540
1138
 
541
1139
        This branch is considered to be 'local', having low latency.
542
1140
        """
543
 
        raise NotImplementedError(self.push)
 
1141
        return InterBranch.get(self, target).push(overwrite, stop_revision,
 
1142
            lossy, *args, **kwargs)
544
1143
 
545
1144
    def basis_tree(self):
546
1145
        """Return `Tree` object for last revision."""
547
1146
        return self.repository.revision_tree(self.last_revision())
548
1147
 
549
 
    def rename_one(self, from_rel, to_rel):
550
 
        """Rename one file.
551
 
 
552
 
        This can change the directory or the filename or both.
553
 
        """
554
 
        raise NotImplementedError(self.rename_one)
555
 
 
556
 
    def move(self, from_paths, to_name):
557
 
        """Rename files.
558
 
 
559
 
        to_name must exist as a versioned directory.
560
 
 
561
 
        If to_name exists and is a directory, the files are moved into
562
 
        it, keeping their old names.  If it is a directory, 
563
 
 
564
 
        Note that to_name is only the last component of the new name;
565
 
        this doesn't change the directory.
566
 
 
567
 
        This returns a list of (from_path, to_path) pairs for each
568
 
        entry that is moved.
569
 
        """
570
 
        raise NotImplementedError(self.move)
571
 
 
572
1148
    def get_parent(self):
573
1149
        """Return the parent location of the branch.
574
1150
 
575
 
        This is the default location for push/pull/missing.  The usual
 
1151
        This is the default location for pull/missing.  The usual
576
1152
        pattern is that the user can override it by specifying a
577
1153
        location.
578
1154
        """
579
 
        raise NotImplementedError(self.get_parent)
 
1155
        parent = self._get_parent_location()
 
1156
        if parent is None:
 
1157
            return parent
 
1158
        # This is an old-format absolute path to a local branch
 
1159
        # turn it into a url
 
1160
        if parent.startswith('/'):
 
1161
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1162
        try:
 
1163
            return urlutils.join(self.base[:-1], parent)
 
1164
        except errors.InvalidURLJoin, e:
 
1165
            raise errors.InaccessibleParent(parent, self.user_url)
 
1166
 
 
1167
    def _get_parent_location(self):
 
1168
        raise NotImplementedError(self._get_parent_location)
580
1169
 
581
1170
    def _set_config_location(self, name, url, config=None,
582
1171
                             make_relative=False):
583
1172
        if config is None:
584
 
            config = self.get_config()
 
1173
            config = self.get_config_stack()
585
1174
        if url is None:
586
1175
            url = ''
587
1176
        elif make_relative:
588
1177
            url = urlutils.relative_url(self.base, url)
589
 
        config.set_user_option(name, url)
 
1178
        config.set(name, url)
590
1179
 
591
1180
    def _get_config_location(self, name, config=None):
592
1181
        if config is None:
593
 
            config = self.get_config()
594
 
        location = config.get_user_option(name)
 
1182
            config = self.get_config_stack()
 
1183
        location = config.get(name)
595
1184
        if location == '':
596
1185
            location = None
597
1186
        return location
598
1187
 
 
1188
    def get_child_submit_format(self):
 
1189
        """Return the preferred format of submissions to this branch."""
 
1190
        return self.get_config_stack().get('child_submit_format')
 
1191
 
599
1192
    def get_submit_branch(self):
600
1193
        """Return the submit location of the branch.
601
1194
 
603
1196
        pattern is that the user can override it by specifying a
604
1197
        location.
605
1198
        """
606
 
        return self.get_config().get_user_option('submit_branch')
 
1199
        return self.get_config_stack().get('submit_branch')
607
1200
 
608
1201
    def set_submit_branch(self, location):
609
1202
        """Return the submit location of the branch.
612
1205
        pattern is that the user can override it by specifying a
613
1206
        location.
614
1207
        """
615
 
        self.get_config().set_user_option('submit_branch', location)
 
1208
        self.get_config_stack().set('submit_branch', location)
616
1209
 
617
1210
    def get_public_branch(self):
618
1211
        """Return the public location of the branch.
619
1212
 
620
 
        This is is used by merge directives.
 
1213
        This is used by merge directives.
621
1214
        """
622
1215
        return self._get_config_location('public_branch')
623
1216
 
631
1224
        self._set_config_location('public_branch', location)
632
1225
 
633
1226
    def get_push_location(self):
634
 
        """Return the None or the location to push this branch to."""
635
 
        push_loc = self.get_config().get_user_option('push_location')
636
 
        return push_loc
 
1227
        """Return None or the location to push this branch to."""
 
1228
        return self.get_config_stack().get('push_location')
637
1229
 
638
1230
    def set_push_location(self, location):
639
1231
        """Set a new push location for this branch."""
640
1232
        raise NotImplementedError(self.set_push_location)
641
1233
 
642
 
    def set_parent(self, url):
643
 
        raise NotImplementedError(self.set_parent)
 
1234
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1235
        """Run the post_change_branch_tip hooks."""
 
1236
        hooks = Branch.hooks['post_change_branch_tip']
 
1237
        if not hooks:
 
1238
            return
 
1239
        new_revno, new_revid = self.last_revision_info()
 
1240
        params = ChangeBranchTipParams(
 
1241
            self, old_revno, new_revno, old_revid, new_revid)
 
1242
        for hook in hooks:
 
1243
            hook(params)
 
1244
 
 
1245
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1246
        """Run the pre_change_branch_tip hooks."""
 
1247
        hooks = Branch.hooks['pre_change_branch_tip']
 
1248
        if not hooks:
 
1249
            return
 
1250
        old_revno, old_revid = self.last_revision_info()
 
1251
        params = ChangeBranchTipParams(
 
1252
            self, old_revno, new_revno, old_revid, new_revid)
 
1253
        for hook in hooks:
 
1254
            hook(params)
644
1255
 
645
1256
    @needs_write_lock
646
1257
    def update(self):
647
 
        """Synchronise this branch with the master branch if any. 
 
1258
        """Synchronise this branch with the master branch if any.
648
1259
 
649
1260
        :return: None or the last_revision pivoted out during the update.
650
1261
        """
657
1268
        """
658
1269
        if revno != 0:
659
1270
            self.check_real_revno(revno)
660
 
            
 
1271
 
661
1272
    def check_real_revno(self, revno):
662
1273
        """\
663
1274
        Check whether a revno corresponds to a real revision.
664
1275
        Zero (the NULL revision) is considered invalid
665
1276
        """
666
1277
        if revno < 1 or revno > self.revno():
667
 
            raise InvalidRevisionNumber(revno)
 
1278
            raise errors.InvalidRevisionNumber(revno)
668
1279
 
669
1280
    @needs_read_lock
670
 
    def clone(self, to_bzrdir, revision_id=None):
 
1281
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
671
1282
        """Clone this branch into to_bzrdir preserving all semantic values.
672
 
        
 
1283
 
 
1284
        Most API users will want 'create_clone_on_transport', which creates a
 
1285
        new bzrdir and branch on the fly.
 
1286
 
673
1287
        revision_id: if not None, the revision history in the new branch will
674
1288
                     be truncated to end with revision_id.
675
1289
        """
676
 
        result = self._format.initialize(to_bzrdir)
677
 
        self.copy_content_into(result, revision_id=revision_id)
678
 
        return  result
 
1290
        result = to_bzrdir.create_branch()
 
1291
        result.lock_write()
 
1292
        try:
 
1293
            if repository_policy is not None:
 
1294
                repository_policy.configure_branch(result)
 
1295
            self.copy_content_into(result, revision_id=revision_id)
 
1296
        finally:
 
1297
            result.unlock()
 
1298
        return result
679
1299
 
680
1300
    @needs_read_lock
681
 
    def sprout(self, to_bzrdir, revision_id=None):
 
1301
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1302
            repository=None):
682
1303
        """Create a new line of development from the branch, into to_bzrdir.
683
 
        
 
1304
 
 
1305
        to_bzrdir controls the branch format.
 
1306
 
684
1307
        revision_id: if not None, the revision history in the new branch will
685
1308
                     be truncated to end with revision_id.
686
1309
        """
687
 
        result = self._format.initialize(to_bzrdir)
688
 
        self.copy_content_into(result, revision_id=revision_id)
689
 
        result.set_parent(self.bzrdir.root_transport.base)
 
1310
        if (repository_policy is not None and
 
1311
            repository_policy.requires_stacking()):
 
1312
            to_bzrdir._format.require_stacking(_skip_repo=True)
 
1313
        result = to_bzrdir.create_branch(repository=repository)
 
1314
        result.lock_write()
 
1315
        try:
 
1316
            if repository_policy is not None:
 
1317
                repository_policy.configure_branch(result)
 
1318
            self.copy_content_into(result, revision_id=revision_id)
 
1319
            master_url = self.get_bound_location()
 
1320
            if master_url is None:
 
1321
                result.set_parent(self.bzrdir.root_transport.base)
 
1322
            else:
 
1323
                result.set_parent(master_url)
 
1324
        finally:
 
1325
            result.unlock()
690
1326
        return result
691
1327
 
692
1328
    def _synchronize_history(self, destination, revision_id):
693
1329
        """Synchronize last revision and revision history between branches.
694
1330
 
695
1331
        This version is most efficient when the destination is also a
696
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
697
 
        history is the true lefthand parent history, and all of the revisions
698
 
        are in the destination's repository.  If not, set_revision_history
699
 
        will fail.
 
1332
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
1333
        repository contains all the lefthand ancestors of the intended
 
1334
        last_revision.  If not, set_last_revision_info will fail.
700
1335
 
701
1336
        :param destination: The branch to copy the history into
702
1337
        :param revision_id: The revision-id to truncate history at.  May
703
1338
          be None to copy complete history.
704
1339
        """
705
 
        new_history = self.revision_history()
706
 
        if revision_id is not None:
707
 
            revision_id = osutils.safe_revision_id(revision_id)
 
1340
        source_revno, source_revision_id = self.last_revision_info()
 
1341
        if revision_id is None:
 
1342
            revno, revision_id = source_revno, source_revision_id
 
1343
        else:
 
1344
            graph = self.repository.get_graph()
708
1345
            try:
709
 
                new_history = new_history[:new_history.index(revision_id) + 1]
710
 
            except ValueError:
711
 
                rev = self.repository.get_revision(revision_id)
712
 
                new_history = rev.get_history(self.repository)[1:]
713
 
        destination.set_revision_history(new_history)
 
1346
                revno = graph.find_distance_to_null(revision_id, 
 
1347
                    [(source_revision_id, source_revno)])
 
1348
            except errors.GhostRevisionsHaveNoRevno:
 
1349
                # Default to 1, if we can't find anything else
 
1350
                revno = 1
 
1351
        destination.set_last_revision_info(revno, revision_id)
714
1352
 
715
 
    @needs_read_lock
716
1353
    def copy_content_into(self, destination, revision_id=None):
717
1354
        """Copy the content of self into destination.
718
1355
 
719
1356
        revision_id: if not None, the revision history in the new branch will
720
1357
                     be truncated to end with revision_id.
721
1358
        """
722
 
        self._synchronize_history(destination, revision_id)
723
 
        try:
724
 
            parent = self.get_parent()
725
 
        except errors.InaccessibleParent, e:
726
 
            mutter('parent was not accessible to copy: %s', e)
727
 
        else:
728
 
            if parent:
729
 
                destination.set_parent(parent)
730
 
        self.tags.merge_to(destination.tags)
 
1359
        return InterBranch.get(self, destination).copy_content_into(
 
1360
            revision_id=revision_id)
 
1361
 
 
1362
    def update_references(self, target):
 
1363
        if not getattr(self._format, 'supports_reference_locations', False):
 
1364
            return
 
1365
        reference_dict = self._get_all_reference_info()
 
1366
        if len(reference_dict) == 0:
 
1367
            return
 
1368
        old_base = self.base
 
1369
        new_base = target.base
 
1370
        target_reference_dict = target._get_all_reference_info()
 
1371
        for file_id, (tree_path, branch_location) in (
 
1372
            reference_dict.items()):
 
1373
            branch_location = urlutils.rebase_url(branch_location,
 
1374
                                                  old_base, new_base)
 
1375
            target_reference_dict.setdefault(
 
1376
                file_id, (tree_path, branch_location))
 
1377
        target._set_all_reference_info(target_reference_dict)
731
1378
 
732
1379
    @needs_read_lock
733
 
    def check(self):
 
1380
    def check(self, refs):
734
1381
        """Check consistency of the branch.
735
1382
 
736
1383
        In particular this checks that revisions given in the revision-history
737
 
        do actually match up in the revision graph, and that they're all 
 
1384
        do actually match up in the revision graph, and that they're all
738
1385
        present in the repository.
739
 
        
 
1386
 
740
1387
        Callers will typically also want to check the repository.
741
1388
 
 
1389
        :param refs: Calculated refs for this branch as specified by
 
1390
            branch._get_check_refs()
742
1391
        :return: A BranchCheckResult.
743
1392
        """
744
 
        mainline_parent_id = None
745
 
        for revision_id in self.revision_history():
746
 
            try:
747
 
                revision = self.repository.get_revision(revision_id)
748
 
            except errors.NoSuchRevision, e:
749
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
750
 
                            % revision_id)
751
 
            # In general the first entry on the revision history has no parents.
752
 
            # But it's not illegal for it to have parents listed; this can happen
753
 
            # in imports from Arch when the parents weren't reachable.
754
 
            if mainline_parent_id is not None:
755
 
                if mainline_parent_id not in revision.parent_ids:
756
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
757
 
                                        "parents of {%s}"
758
 
                                        % (mainline_parent_id, revision_id))
759
 
            mainline_parent_id = revision_id
760
 
        return BranchCheckResult(self)
 
1393
        result = BranchCheckResult(self)
 
1394
        last_revno, last_revision_id = self.last_revision_info()
 
1395
        actual_revno = refs[('lefthand-distance', last_revision_id)]
 
1396
        if actual_revno != last_revno:
 
1397
            result.errors.append(errors.BzrCheckError(
 
1398
                'revno does not match len(mainline) %s != %s' % (
 
1399
                last_revno, actual_revno)))
 
1400
        # TODO: We should probably also check that self.revision_history
 
1401
        # matches the repository for older branch formats.
 
1402
        # If looking for the code that cross-checks repository parents against
 
1403
        # the Graph.iter_lefthand_ancestry output, that is now a repository
 
1404
        # specific check.
 
1405
        return result
761
1406
 
762
 
    def _get_checkout_format(self):
 
1407
    def _get_checkout_format(self, lightweight=False):
763
1408
        """Return the most suitable metadir for a checkout of this branch.
764
1409
        Weaves are used if this branch's repository uses weaves.
765
1410
        """
766
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
767
 
            from bzrlib.repofmt import weaverepo
768
 
            format = bzrdir.BzrDirMetaFormat1()
769
 
            format.repository_format = weaverepo.RepositoryFormat7()
770
 
        else:
771
 
            format = self.repository.bzrdir.checkout_metadir()
772
 
            format.set_branch_format(self._format)
 
1411
        format = self.repository.bzrdir.checkout_metadir()
 
1412
        format.set_branch_format(self._format)
773
1413
        return format
774
1414
 
 
1415
    def create_clone_on_transport(self, to_transport, revision_id=None,
 
1416
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1417
        no_tree=None):
 
1418
        """Create a clone of this branch and its bzrdir.
 
1419
 
 
1420
        :param to_transport: The transport to clone onto.
 
1421
        :param revision_id: The revision id to use as tip in the new branch.
 
1422
            If None the tip is obtained from this branch.
 
1423
        :param stacked_on: An optional URL to stack the clone on.
 
1424
        :param create_prefix: Create any missing directories leading up to
 
1425
            to_transport.
 
1426
        :param use_existing_dir: Use an existing directory if one exists.
 
1427
        """
 
1428
        # XXX: Fix the bzrdir API to allow getting the branch back from the
 
1429
        # clone call. Or something. 20090224 RBC/spiv.
 
1430
        # XXX: Should this perhaps clone colocated branches as well, 
 
1431
        # rather than just the default branch? 20100319 JRV
 
1432
        if revision_id is None:
 
1433
            revision_id = self.last_revision()
 
1434
        dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1435
            revision_id=revision_id, stacked_on=stacked_on,
 
1436
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1437
            no_tree=no_tree)
 
1438
        return dir_to.open_branch()
 
1439
 
775
1440
    def create_checkout(self, to_location, revision_id=None,
776
 
                        lightweight=False):
 
1441
                        lightweight=False, accelerator_tree=None,
 
1442
                        hardlink=False):
777
1443
        """Create a checkout of a branch.
778
 
        
 
1444
 
779
1445
        :param to_location: The url to produce the checkout at
780
1446
        :param revision_id: The revision to check out
781
1447
        :param lightweight: If True, produce a lightweight checkout, otherwise,
782
 
        produce a bound branch (heavyweight checkout)
 
1448
            produce a bound branch (heavyweight checkout)
 
1449
        :param accelerator_tree: A tree which can be used for retrieving file
 
1450
            contents more quickly than the revision tree, i.e. a workingtree.
 
1451
            The revision tree will be used for cases where accelerator_tree's
 
1452
            content is different.
 
1453
        :param hardlink: If true, hard-link files from accelerator_tree,
 
1454
            where possible.
783
1455
        :return: The tree of the created checkout
784
1456
        """
785
1457
        t = transport.get_transport(to_location)
786
1458
        t.ensure_base()
 
1459
        format = self._get_checkout_format(lightweight=lightweight)
 
1460
        try:
 
1461
            checkout = format.initialize_on_transport(t)
 
1462
        except errors.AlreadyControlDirError:
 
1463
            # It's fine if the control directory already exists,
 
1464
            # as long as there is no existing branch and working tree.
 
1465
            checkout = controldir.ControlDir.open_from_transport(t)
 
1466
            try:
 
1467
                checkout.open_branch()
 
1468
            except errors.NotBranchError:
 
1469
                pass
 
1470
            else:
 
1471
                raise errors.AlreadyControlDirError(t.base)
 
1472
            if checkout.control_transport.base == self.bzrdir.control_transport.base:
 
1473
                # When checking out to the same control directory,
 
1474
                # always create a lightweight checkout
 
1475
                lightweight = True
 
1476
 
787
1477
        if lightweight:
788
 
            format = self._get_checkout_format()
789
 
            checkout = format.initialize_on_transport(t)
790
 
            BranchReferenceFormat().initialize(checkout, self)
 
1478
            from_branch = checkout.set_branch_reference(target_branch=self)
791
1479
        else:
792
 
            format = self._get_checkout_format()
793
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
794
 
                to_location, force_new_tree=False, format=format)
795
 
            checkout = checkout_branch.bzrdir
 
1480
            policy = checkout.determine_repository_policy()
 
1481
            repo = policy.acquire_repository()[0]
 
1482
            checkout_branch = checkout.create_branch()
796
1483
            checkout_branch.bind(self)
797
 
            # pull up to the specified revision_id to set the initial 
 
1484
            # pull up to the specified revision_id to set the initial
798
1485
            # branch tip correctly, and seed it with history.
799
1486
            checkout_branch.pull(self, stop_revision=revision_id)
800
 
        tree = checkout.create_workingtree(revision_id)
 
1487
            from_branch = None
 
1488
        tree = checkout.create_workingtree(revision_id,
 
1489
                                           from_branch=from_branch,
 
1490
                                           accelerator_tree=accelerator_tree,
 
1491
                                           hardlink=hardlink)
801
1492
        basis_tree = tree.basis_tree()
802
1493
        basis_tree.lock_read()
803
1494
        try:
810
1501
            basis_tree.unlock()
811
1502
        return tree
812
1503
 
813
 
    def reference_parent(self, file_id, path):
 
1504
    @needs_write_lock
 
1505
    def reconcile(self, thorough=True):
 
1506
        """Make sure the data stored in this branch is consistent."""
 
1507
        from bzrlib.reconcile import BranchReconciler
 
1508
        reconciler = BranchReconciler(self, thorough=thorough)
 
1509
        reconciler.reconcile()
 
1510
        return reconciler
 
1511
 
 
1512
    def reference_parent(self, file_id, path, possible_transports=None):
814
1513
        """Return the parent branch for a tree-reference file_id
 
1514
 
815
1515
        :param file_id: The file_id of the tree reference
816
1516
        :param path: The path of the file_id in the tree
817
1517
        :return: A branch associated with the file_id
818
1518
        """
819
1519
        # FIXME should provide multiple branches, based on config
820
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
 
1520
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
 
1521
                           possible_transports=possible_transports)
821
1522
 
822
1523
    def supports_tags(self):
823
1524
        return self._format.supports_tags()
824
1525
 
825
 
 
826
 
class BranchFormat(object):
 
1526
    def automatic_tag_name(self, revision_id):
 
1527
        """Try to automatically find the tag name for a revision.
 
1528
 
 
1529
        :param revision_id: Revision id of the revision.
 
1530
        :return: A tag name or None if no tag name could be determined.
 
1531
        """
 
1532
        for hook in Branch.hooks['automatic_tag_name']:
 
1533
            ret = hook(self, revision_id)
 
1534
            if ret is not None:
 
1535
                return ret
 
1536
        return None
 
1537
 
 
1538
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
 
1539
                                         other_branch):
 
1540
        """Ensure that revision_b is a descendant of revision_a.
 
1541
 
 
1542
        This is a helper function for update_revisions.
 
1543
 
 
1544
        :raises: DivergedBranches if revision_b has diverged from revision_a.
 
1545
        :returns: True if revision_b is a descendant of revision_a.
 
1546
        """
 
1547
        relation = self._revision_relations(revision_a, revision_b, graph)
 
1548
        if relation == 'b_descends_from_a':
 
1549
            return True
 
1550
        elif relation == 'diverged':
 
1551
            raise errors.DivergedBranches(self, other_branch)
 
1552
        elif relation == 'a_descends_from_b':
 
1553
            return False
 
1554
        else:
 
1555
            raise AssertionError("invalid relation: %r" % (relation,))
 
1556
 
 
1557
    def _revision_relations(self, revision_a, revision_b, graph):
 
1558
        """Determine the relationship between two revisions.
 
1559
 
 
1560
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
 
1561
        """
 
1562
        heads = graph.heads([revision_a, revision_b])
 
1563
        if heads == set([revision_b]):
 
1564
            return 'b_descends_from_a'
 
1565
        elif heads == set([revision_a, revision_b]):
 
1566
            # These branches have diverged
 
1567
            return 'diverged'
 
1568
        elif heads == set([revision_a]):
 
1569
            return 'a_descends_from_b'
 
1570
        else:
 
1571
            raise AssertionError("invalid heads: %r" % (heads,))
 
1572
 
 
1573
    def heads_to_fetch(self):
 
1574
        """Return the heads that must and that should be fetched to copy this
 
1575
        branch into another repo.
 
1576
 
 
1577
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1578
            set of heads that must be fetched.  if_present_fetch is a set of
 
1579
            heads that must be fetched if present, but no error is necessary if
 
1580
            they are not present.
 
1581
        """
 
1582
        # For bzr native formats must_fetch is just the tip, and
 
1583
        # if_present_fetch are the tags.
 
1584
        must_fetch = set([self.last_revision()])
 
1585
        if_present_fetch = set()
 
1586
        if self.get_config_stack().get('branch.fetch_tags'):
 
1587
            try:
 
1588
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1589
            except errors.TagsNotSupported:
 
1590
                pass
 
1591
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1592
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1593
        return must_fetch, if_present_fetch
 
1594
 
 
1595
 
 
1596
class BranchFormat(controldir.ControlComponentFormat):
827
1597
    """An encapsulation of the initialization and open routines for a format.
828
1598
 
829
1599
    Formats provide three things:
830
1600
     * An initialization routine,
831
 
     * a format string,
 
1601
     * a format description
832
1602
     * an open routine.
833
1603
 
834
 
    Formats are placed in an dict by their format string for reference 
835
 
    during branch opening. Its not required that these be instances, they
836
 
    can be classes themselves with class methods - it simply depends on 
 
1604
    Formats are placed in an dict by their format string for reference
 
1605
    during branch opening. It's not required that these be instances, they
 
1606
    can be classes themselves with class methods - it simply depends on
837
1607
    whether state is needed for a given format or not.
838
1608
 
839
1609
    Once a format is deprecated, just deprecate the initialize and open
840
 
    methods on the format class. Do not deprecate the object, as the 
 
1610
    methods on the format class. Do not deprecate the object, as the
841
1611
    object will be created every time regardless.
842
1612
    """
843
1613
 
844
 
    _default_format = None
845
 
    """The default format used for new branches."""
846
 
 
847
 
    _formats = {}
848
 
    """The known formats."""
849
 
 
850
 
    @classmethod
851
 
    def find_format(klass, a_bzrdir):
852
 
        """Return the format for the branch object in a_bzrdir."""
853
 
        try:
854
 
            transport = a_bzrdir.get_branch_transport(None)
855
 
            format_string = transport.get("format").read()
856
 
            return klass._formats[format_string]
857
 
        except NoSuchFile:
858
 
            raise NotBranchError(path=transport.base)
859
 
        except KeyError:
860
 
            raise errors.UnknownFormatError(format=format_string)
861
 
 
862
 
    @classmethod
 
1614
    def __eq__(self, other):
 
1615
        return self.__class__ is other.__class__
 
1616
 
 
1617
    def __ne__(self, other):
 
1618
        return not (self == other)
 
1619
 
 
1620
    @classmethod
 
1621
    @deprecated_method(deprecated_in((2, 4, 0)))
863
1622
    def get_default_format(klass):
864
1623
        """Return the current default format."""
865
 
        return klass._default_format
866
 
 
867
 
    def get_reference(self, a_bzrdir):
868
 
        """Get the target reference of the branch in a_bzrdir.
 
1624
        return format_registry.get_default()
 
1625
 
 
1626
    @classmethod
 
1627
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1628
    def get_formats(klass):
 
1629
        """Get all the known formats.
 
1630
 
 
1631
        Warning: This triggers a load of all lazy registered formats: do not
 
1632
        use except when that is desireed.
 
1633
        """
 
1634
        return format_registry._get_all()
 
1635
 
 
1636
    def get_reference(self, controldir, name=None):
 
1637
        """Get the target reference of the branch in controldir.
869
1638
 
870
1639
        format probing must have been completed before calling
871
1640
        this method - it is assumed that the format of the branch
872
 
        in a_bzrdir is correct.
 
1641
        in controldir is correct.
873
1642
 
874
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1643
        :param controldir: The controldir to get the branch data from.
 
1644
        :param name: Name of the colocated branch to fetch
875
1645
        :return: None if the branch is not a reference branch.
876
1646
        """
877
1647
        return None
878
1648
 
879
 
    def get_format_string(self):
880
 
        """Return the ASCII format string that identifies this format."""
881
 
        raise NotImplementedError(self.get_format_string)
 
1649
    @classmethod
 
1650
    def set_reference(self, controldir, name, to_branch):
 
1651
        """Set the target reference of the branch in controldir.
 
1652
 
 
1653
        format probing must have been completed before calling
 
1654
        this method - it is assumed that the format of the branch
 
1655
        in controldir is correct.
 
1656
 
 
1657
        :param controldir: The controldir to set the branch reference for.
 
1658
        :param name: Name of colocated branch to set, None for default
 
1659
        :param to_branch: branch that the checkout is to reference
 
1660
        """
 
1661
        raise NotImplementedError(self.set_reference)
882
1662
 
883
1663
    def get_format_description(self):
884
1664
        """Return the short format description for this format."""
885
1665
        raise NotImplementedError(self.get_format_description)
886
1666
 
887
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
888
 
                           set_format=True):
889
 
        """Initialize a branch in a bzrdir, with specified files
890
 
 
891
 
        :param a_bzrdir: The bzrdir to initialize the branch in
892
 
        :param utf8_files: The files to create as a list of
893
 
            (filename, content) tuples
894
 
        :param set_format: If True, set the format with
895
 
            self.get_format_string.  (BzrBranch4 has its format set
896
 
            elsewhere)
897
 
        :return: a branch in this format
 
1667
    def _run_post_branch_init_hooks(self, controldir, name, branch):
 
1668
        hooks = Branch.hooks['post_branch_init']
 
1669
        if not hooks:
 
1670
            return
 
1671
        params = BranchInitHookParams(self, controldir, name, branch)
 
1672
        for hook in hooks:
 
1673
            hook(params)
 
1674
 
 
1675
    def initialize(self, controldir, name=None, repository=None,
 
1676
                   append_revisions_only=None):
 
1677
        """Create a branch of this format in controldir.
 
1678
 
 
1679
        :param name: Name of the colocated branch to create.
898
1680
        """
899
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
900
 
        branch_transport = a_bzrdir.get_branch_transport(self)
901
 
        lock_map = {
902
 
            'metadir': ('lock', lockdir.LockDir),
903
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
904
 
        }
905
 
        lock_name, lock_class = lock_map[lock_type]
906
 
        control_files = lockable_files.LockableFiles(branch_transport,
907
 
            lock_name, lock_class)
908
 
        control_files.create_lock()
909
 
        control_files.lock_write()
910
 
        if set_format:
911
 
            control_files.put_utf8('format', self.get_format_string())
912
 
        try:
913
 
            for file, content in utf8_files:
914
 
                control_files.put_utf8(file, content)
915
 
        finally:
916
 
            control_files.unlock()
917
 
        return self.open(a_bzrdir, _found=True)
918
 
 
919
 
    def initialize(self, a_bzrdir):
920
 
        """Create a branch of this format in a_bzrdir."""
921
1681
        raise NotImplementedError(self.initialize)
922
1682
 
923
1683
    def is_supported(self):
924
1684
        """Is this format supported?
925
1685
 
926
1686
        Supported formats can be initialized and opened.
927
 
        Unsupported formats may not support initialization or committing or 
 
1687
        Unsupported formats may not support initialization or committing or
928
1688
        some other features depending on the reason for not being supported.
929
1689
        """
930
1690
        return True
931
1691
 
932
 
    def open(self, a_bzrdir, _found=False):
933
 
        """Return the branch object for a_bzrdir
934
 
 
935
 
        _found is a private parameter, do not use it. It is used to indicate
936
 
               if format probing has already be done.
 
1692
    def make_tags(self, branch):
 
1693
        """Create a tags object for branch.
 
1694
 
 
1695
        This method is on BranchFormat, because BranchFormats are reflected
 
1696
        over the wire via network_name(), whereas full Branch instances require
 
1697
        multiple VFS method calls to operate at all.
 
1698
 
 
1699
        The default implementation returns a disabled-tags instance.
 
1700
 
 
1701
        Note that it is normal for branch to be a RemoteBranch when using tags
 
1702
        on a RemoteBranch.
 
1703
        """
 
1704
        return _mod_tag.DisabledTags(branch)
 
1705
 
 
1706
    def network_name(self):
 
1707
        """A simple byte string uniquely identifying this format for RPC calls.
 
1708
 
 
1709
        MetaDir branch formats use their disk format string to identify the
 
1710
        repository over the wire. All in one formats such as bzr < 0.8, and
 
1711
        foreign formats like svn/git and hg should use some marker which is
 
1712
        unique and immutable.
 
1713
        """
 
1714
        raise NotImplementedError(self.network_name)
 
1715
 
 
1716
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1717
            found_repository=None, possible_transports=None):
 
1718
        """Return the branch object for controldir.
 
1719
 
 
1720
        :param controldir: A ControlDir that contains a branch.
 
1721
        :param name: Name of colocated branch to open
 
1722
        :param _found: a private parameter, do not use it. It is used to
 
1723
            indicate if format probing has already be done.
 
1724
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
1725
            (if there are any).  Default is to open fallbacks.
937
1726
        """
938
1727
        raise NotImplementedError(self.open)
939
1728
 
940
1729
    @classmethod
 
1730
    @deprecated_method(deprecated_in((2, 4, 0)))
941
1731
    def register_format(klass, format):
942
 
        klass._formats[format.get_format_string()] = format
 
1732
        """Register a metadir format.
 
1733
 
 
1734
        See MetaDirBranchFormatFactory for the ability to register a format
 
1735
        without loading the code the format needs until it is actually used.
 
1736
        """
 
1737
        format_registry.register(format)
943
1738
 
944
1739
    @classmethod
 
1740
    @deprecated_method(deprecated_in((2, 4, 0)))
945
1741
    def set_default_format(klass, format):
946
 
        klass._default_format = format
 
1742
        format_registry.set_default(format)
 
1743
 
 
1744
    def supports_set_append_revisions_only(self):
 
1745
        """True if this format supports set_append_revisions_only."""
 
1746
        return False
 
1747
 
 
1748
    def supports_stacking(self):
 
1749
        """True if this format records a stacked-on branch."""
 
1750
        return False
 
1751
 
 
1752
    def supports_leaving_lock(self):
 
1753
        """True if this format supports leaving locks in place."""
 
1754
        return False # by default
947
1755
 
948
1756
    @classmethod
 
1757
    @deprecated_method(deprecated_in((2, 4, 0)))
949
1758
    def unregister_format(klass, format):
950
 
        assert klass._formats[format.get_format_string()] is format
951
 
        del klass._formats[format.get_format_string()]
 
1759
        format_registry.remove(format)
952
1760
 
953
1761
    def __str__(self):
954
 
        return self.get_format_string().rstrip()
 
1762
        return self.get_format_description().rstrip()
955
1763
 
956
1764
    def supports_tags(self):
957
1765
        """True if this format supports tags stored in the branch"""
958
1766
        return False  # by default
959
1767
 
960
 
    # XXX: Probably doesn't really belong here -- mbp 20070212
961
 
    def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
962
 
            lock_class):
963
 
        branch_transport = a_bzrdir.get_branch_transport(self)
964
 
        control_files = lockable_files.LockableFiles(branch_transport,
965
 
            lock_filename, lock_class)
966
 
        control_files.create_lock()
967
 
        control_files.lock_write()
968
 
        try:
969
 
            for filename, content in utf8_files:
970
 
                control_files.put_utf8(filename, content)
971
 
        finally:
972
 
            control_files.unlock()
 
1768
    def tags_are_versioned(self):
 
1769
        """Whether the tag container for this branch versions tags."""
 
1770
        return False
 
1771
 
 
1772
    def supports_tags_referencing_ghosts(self):
 
1773
        """True if tags can reference ghost revisions."""
 
1774
        return True
 
1775
 
 
1776
 
 
1777
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1778
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1779
    
 
1780
    While none of the built in BranchFormats are lazy registered yet,
 
1781
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1782
    use it, and the bzr-loom plugin uses it as well (see
 
1783
    bzrlib.plugins.loom.formats).
 
1784
    """
 
1785
 
 
1786
    def __init__(self, format_string, module_name, member_name):
 
1787
        """Create a MetaDirBranchFormatFactory.
 
1788
 
 
1789
        :param format_string: The format string the format has.
 
1790
        :param module_name: Module to load the format class from.
 
1791
        :param member_name: Attribute name within the module for the format class.
 
1792
        """
 
1793
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1794
        self._format_string = format_string
 
1795
 
 
1796
    def get_format_string(self):
 
1797
        """See BranchFormat.get_format_string."""
 
1798
        return self._format_string
 
1799
 
 
1800
    def __call__(self):
 
1801
        """Used for network_format_registry support."""
 
1802
        return self.get_obj()()
973
1803
 
974
1804
 
975
1805
class BranchHooks(Hooks):
976
1806
    """A dictionary mapping hook name to a list of callables for branch hooks.
977
 
    
 
1807
 
978
1808
    e.g. ['set_rh'] Is the list of items to be called when the
979
1809
    set_revision_history function is invoked.
980
1810
    """
985
1815
        These are all empty initially, because by default nothing should get
986
1816
        notified.
987
1817
        """
988
 
        Hooks.__init__(self)
989
 
        # Introduced in 0.15:
990
 
        # invoked whenever the revision history has been set
991
 
        # with set_revision_history. The api signature is
992
 
        # (branch, revision_history), and the branch will
993
 
        # be write-locked.
994
 
        self['set_rh'] = []
995
 
        # invoked after a push operation completes.
996
 
        # the api signature is
997
 
        # (push_result)
998
 
        # containing the members
999
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
 
        # where local is the local target branch or None, master is the target 
1001
 
        # master branch, and the rest should be self explanatory. The source
1002
 
        # is read locked and the target branches write locked. Source will
1003
 
        # be the local low-latency branch.
1004
 
        self['post_push'] = []
1005
 
        # invoked after a pull operation completes.
1006
 
        # the api signature is
1007
 
        # (pull_result)
1008
 
        # containing the members
1009
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1010
 
        # where local is the local branch or None, master is the target 
1011
 
        # master branch, and the rest should be self explanatory. The source
1012
 
        # is read locked and the target branches write locked. The local
1013
 
        # branch is the low-latency branch.
1014
 
        self['post_pull'] = []
1015
 
        # invoked after a commit operation completes.
1016
 
        # the api signature is 
1017
 
        # (local, master, old_revno, old_revid, new_revno, new_revid)
1018
 
        # old_revid is NULL_REVISION for the first commit to a branch.
1019
 
        self['post_commit'] = []
1020
 
        # invoked after a uncommit operation completes.
1021
 
        # the api signature is
1022
 
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
1023
 
        # local is the local branch or None, master is the target branch,
1024
 
        # and an empty branch recieves new_revno of 0, new_revid of None.
1025
 
        self['post_uncommit'] = []
 
1818
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1819
        self.add_hook('set_rh',
 
1820
            "Invoked whenever the revision history has been set via "
 
1821
            "set_revision_history. The api signature is (branch, "
 
1822
            "revision_history), and the branch will be write-locked. "
 
1823
            "The set_rh hook can be expensive for bzr to trigger, a better "
 
1824
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1825
        self.add_hook('open',
 
1826
            "Called with the Branch object that has been opened after a "
 
1827
            "branch is opened.", (1, 8))
 
1828
        self.add_hook('post_push',
 
1829
            "Called after a push operation completes. post_push is called "
 
1830
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
 
1831
            "bzr client.", (0, 15))
 
1832
        self.add_hook('post_pull',
 
1833
            "Called after a pull operation completes. post_pull is called "
 
1834
            "with a bzrlib.branch.PullResult object and only runs in the "
 
1835
            "bzr client.", (0, 15))
 
1836
        self.add_hook('pre_commit',
 
1837
            "Called after a commit is calculated but before it is "
 
1838
            "completed. pre_commit is called with (local, master, old_revno, "
 
1839
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
 
1840
            "). old_revid is NULL_REVISION for the first commit to a branch, "
 
1841
            "tree_delta is a TreeDelta object describing changes from the "
 
1842
            "basis revision. hooks MUST NOT modify this delta. "
 
1843
            " future_tree is an in-memory tree obtained from "
 
1844
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
 
1845
            "tree.", (0,91))
 
1846
        self.add_hook('post_commit',
 
1847
            "Called in the bzr client after a commit has completed. "
 
1848
            "post_commit is called with (local, master, old_revno, old_revid, "
 
1849
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
 
1850
            "commit to a branch.", (0, 15))
 
1851
        self.add_hook('post_uncommit',
 
1852
            "Called in the bzr client after an uncommit completes. "
 
1853
            "post_uncommit is called with (local, master, old_revno, "
 
1854
            "old_revid, new_revno, new_revid) where local is the local branch "
 
1855
            "or None, master is the target branch, and an empty branch "
 
1856
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1857
        self.add_hook('pre_change_branch_tip',
 
1858
            "Called in bzr client and server before a change to the tip of a "
 
1859
            "branch is made. pre_change_branch_tip is called with a "
 
1860
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1861
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1862
        self.add_hook('post_change_branch_tip',
 
1863
            "Called in bzr client and server after a change to the tip of a "
 
1864
            "branch is made. post_change_branch_tip is called with a "
 
1865
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1866
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1867
        self.add_hook('transform_fallback_location',
 
1868
            "Called when a stacked branch is activating its fallback "
 
1869
            "locations. transform_fallback_location is called with (branch, "
 
1870
            "url), and should return a new url. Returning the same url "
 
1871
            "allows it to be used as-is, returning a different one can be "
 
1872
            "used to cause the branch to stack on a closer copy of that "
 
1873
            "fallback_location. Note that the branch cannot have history "
 
1874
            "accessing methods called on it during this hook because the "
 
1875
            "fallback locations have not been activated. When there are "
 
1876
            "multiple hooks installed for transform_fallback_location, "
 
1877
            "all are called with the url returned from the previous hook."
 
1878
            "The order is however undefined.", (1, 9))
 
1879
        self.add_hook('automatic_tag_name',
 
1880
            "Called to determine an automatic tag name for a revision. "
 
1881
            "automatic_tag_name is called with (branch, revision_id) and "
 
1882
            "should return a tag name or None if no tag name could be "
 
1883
            "determined. The first non-None tag name returned will be used.",
 
1884
            (2, 2))
 
1885
        self.add_hook('post_branch_init',
 
1886
            "Called after new branch initialization completes. "
 
1887
            "post_branch_init is called with a "
 
1888
            "bzrlib.branch.BranchInitHookParams. "
 
1889
            "Note that init, branch and checkout (both heavyweight and "
 
1890
            "lightweight) will all trigger this hook.", (2, 2))
 
1891
        self.add_hook('post_switch',
 
1892
            "Called after a checkout switches branch. "
 
1893
            "post_switch is called with a "
 
1894
            "bzrlib.branch.SwitchHookParams.", (2, 2))
 
1895
 
1026
1896
 
1027
1897
 
1028
1898
# install the default hooks into the Branch class.
1029
1899
Branch.hooks = BranchHooks()
1030
1900
 
1031
1901
 
1032
 
class BzrBranchFormat4(BranchFormat):
1033
 
    """Bzr branch format 4.
1034
 
 
1035
 
    This format has:
1036
 
     - a revision-history file.
1037
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1038
 
    """
1039
 
 
1040
 
    def get_format_description(self):
1041
 
        """See BranchFormat.get_format_description()."""
1042
 
        return "Branch format 4"
1043
 
 
1044
 
    def initialize(self, a_bzrdir):
1045
 
        """Create a branch of this format in a_bzrdir."""
1046
 
        utf8_files = [('revision-history', ''),
1047
 
                      ('branch-name', ''),
1048
 
                      ]
1049
 
        return self._initialize_helper(a_bzrdir, utf8_files,
1050
 
                                       lock_type='branch4', set_format=False)
 
1902
class ChangeBranchTipParams(object):
 
1903
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1904
 
 
1905
    There are 5 fields that hooks may wish to access:
 
1906
 
 
1907
    :ivar branch: the branch being changed
 
1908
    :ivar old_revno: revision number before the change
 
1909
    :ivar new_revno: revision number after the change
 
1910
    :ivar old_revid: revision id before the change
 
1911
    :ivar new_revid: revision id after the change
 
1912
 
 
1913
    The revid fields are strings. The revno fields are integers.
 
1914
    """
 
1915
 
 
1916
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
 
1917
        """Create a group of ChangeBranchTip parameters.
 
1918
 
 
1919
        :param branch: The branch being changed.
 
1920
        :param old_revno: Revision number before the change.
 
1921
        :param new_revno: Revision number after the change.
 
1922
        :param old_revid: Tip revision id before the change.
 
1923
        :param new_revid: Tip revision id after the change.
 
1924
        """
 
1925
        self.branch = branch
 
1926
        self.old_revno = old_revno
 
1927
        self.new_revno = new_revno
 
1928
        self.old_revid = old_revid
 
1929
        self.new_revid = new_revid
 
1930
 
 
1931
    def __eq__(self, other):
 
1932
        return self.__dict__ == other.__dict__
 
1933
 
 
1934
    def __repr__(self):
 
1935
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
 
1936
            self.__class__.__name__, self.branch,
 
1937
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
 
1938
 
 
1939
 
 
1940
class BranchInitHookParams(object):
 
1941
    """Object holding parameters passed to `*_branch_init` hooks.
 
1942
 
 
1943
    There are 4 fields that hooks may wish to access:
 
1944
 
 
1945
    :ivar format: the branch format
 
1946
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
 
1947
    :ivar name: name of colocated branch, if any (or None)
 
1948
    :ivar branch: the branch created
 
1949
 
 
1950
    Note that for lightweight checkouts, the bzrdir and format fields refer to
 
1951
    the checkout, hence they are different from the corresponding fields in
 
1952
    branch, which refer to the original branch.
 
1953
    """
 
1954
 
 
1955
    def __init__(self, format, controldir, name, branch):
 
1956
        """Create a group of BranchInitHook parameters.
 
1957
 
 
1958
        :param format: the branch format
 
1959
        :param controldir: the ControlDir where the branch will be/has been
 
1960
            initialized
 
1961
        :param name: name of colocated branch, if any (or None)
 
1962
        :param branch: the branch created
 
1963
 
 
1964
        Note that for lightweight checkouts, the bzrdir and format fields refer
 
1965
        to the checkout, hence they are different from the corresponding fields
 
1966
        in branch, which refer to the original branch.
 
1967
        """
 
1968
        self.format = format
 
1969
        self.bzrdir = controldir
 
1970
        self.name = name
 
1971
        self.branch = branch
 
1972
 
 
1973
    def __eq__(self, other):
 
1974
        return self.__dict__ == other.__dict__
 
1975
 
 
1976
    def __repr__(self):
 
1977
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1978
 
 
1979
 
 
1980
class SwitchHookParams(object):
 
1981
    """Object holding parameters passed to `*_switch` hooks.
 
1982
 
 
1983
    There are 4 fields that hooks may wish to access:
 
1984
 
 
1985
    :ivar control_dir: ControlDir of the checkout to change
 
1986
    :ivar to_branch: branch that the checkout is to reference
 
1987
    :ivar force: skip the check for local commits in a heavy checkout
 
1988
    :ivar revision_id: revision ID to switch to (or None)
 
1989
    """
 
1990
 
 
1991
    def __init__(self, control_dir, to_branch, force, revision_id):
 
1992
        """Create a group of SwitchHook parameters.
 
1993
 
 
1994
        :param control_dir: ControlDir of the checkout to change
 
1995
        :param to_branch: branch that the checkout is to reference
 
1996
        :param force: skip the check for local commits in a heavy checkout
 
1997
        :param revision_id: revision ID to switch to (or None)
 
1998
        """
 
1999
        self.control_dir = control_dir
 
2000
        self.to_branch = to_branch
 
2001
        self.force = force
 
2002
        self.revision_id = revision_id
 
2003
 
 
2004
    def __eq__(self, other):
 
2005
        return self.__dict__ == other.__dict__
 
2006
 
 
2007
    def __repr__(self):
 
2008
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
 
2009
            self.control_dir, self.to_branch,
 
2010
            self.revision_id)
 
2011
 
 
2012
 
 
2013
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
 
2014
    """Base class for branch formats that live in meta directories.
 
2015
    """
1051
2016
 
1052
2017
    def __init__(self):
1053
 
        super(BzrBranchFormat4, self).__init__()
1054
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1055
 
 
1056
 
    def open(self, a_bzrdir, _found=False):
1057
 
        """Return the branch object for a_bzrdir
1058
 
 
1059
 
        _found is a private parameter, do not use it. It is used to indicate
1060
 
               if format probing has already be done.
 
2018
        BranchFormat.__init__(self)
 
2019
        bzrdir.BzrFormat.__init__(self)
 
2020
 
 
2021
    @classmethod
 
2022
    def find_format(klass, controldir, name=None):
 
2023
        """Return the format for the branch object in controldir."""
 
2024
        try:
 
2025
            transport = controldir.get_branch_transport(None, name=name)
 
2026
        except errors.NoSuchFile:
 
2027
            raise errors.NotBranchError(path=name, bzrdir=controldir)
 
2028
        try:
 
2029
            format_string = transport.get_bytes("format")
 
2030
        except errors.NoSuchFile:
 
2031
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
 
2032
        return klass._find_format(format_registry, 'branch', format_string)
 
2033
 
 
2034
    def _branch_class(self):
 
2035
        """What class to instantiate on open calls."""
 
2036
        raise NotImplementedError(self._branch_class)
 
2037
 
 
2038
    def _get_initial_config(self, append_revisions_only=None):
 
2039
        if append_revisions_only:
 
2040
            return "append_revisions_only = True\n"
 
2041
        else:
 
2042
            # Avoid writing anything if append_revisions_only is disabled,
 
2043
            # as that is the default.
 
2044
            return ""
 
2045
 
 
2046
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2047
                           repository=None):
 
2048
        """Initialize a branch in a bzrdir, with specified files
 
2049
 
 
2050
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2051
        :param utf8_files: The files to create as a list of
 
2052
            (filename, content) tuples
 
2053
        :param name: Name of colocated branch to create, if any
 
2054
        :return: a branch in this format
1061
2055
        """
 
2056
        if name is None:
 
2057
            name = a_bzrdir._get_selected_branch()
 
2058
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2059
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2060
        control_files = lockable_files.LockableFiles(branch_transport,
 
2061
            'lock', lockdir.LockDir)
 
2062
        control_files.create_lock()
 
2063
        control_files.lock_write()
 
2064
        try:
 
2065
            utf8_files += [('format', self.as_string())]
 
2066
            for (filename, content) in utf8_files:
 
2067
                branch_transport.put_bytes(
 
2068
                    filename, content,
 
2069
                    mode=a_bzrdir._get_file_mode())
 
2070
        finally:
 
2071
            control_files.unlock()
 
2072
        branch = self.open(a_bzrdir, name, _found=True,
 
2073
                found_repository=repository)
 
2074
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2075
        return branch
 
2076
 
 
2077
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2078
            found_repository=None, possible_transports=None):
 
2079
        """See BranchFormat.open()."""
 
2080
        if name is None:
 
2081
            name = a_bzrdir._get_selected_branch()
1062
2082
        if not _found:
1063
 
            # we are being called directly and must probe.
1064
 
            raise NotImplementedError
1065
 
        return BzrBranch(_format=self,
1066
 
                         _control_files=a_bzrdir._control_files,
1067
 
                         a_bzrdir=a_bzrdir,
1068
 
                         _repository=a_bzrdir.open_repository())
1069
 
 
1070
 
    def __str__(self):
1071
 
        return "Bazaar-NG branch format 4"
1072
 
 
1073
 
 
1074
 
class BzrBranchFormat5(BranchFormat):
 
2083
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
 
2084
            if format.__class__ != self.__class__:
 
2085
                raise AssertionError("wrong format %r found for %r" %
 
2086
                    (format, self))
 
2087
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2088
        try:
 
2089
            control_files = lockable_files.LockableFiles(transport, 'lock',
 
2090
                                                         lockdir.LockDir)
 
2091
            if found_repository is None:
 
2092
                found_repository = a_bzrdir.find_repository()
 
2093
            return self._branch_class()(_format=self,
 
2094
                              _control_files=control_files,
 
2095
                              name=name,
 
2096
                              a_bzrdir=a_bzrdir,
 
2097
                              _repository=found_repository,
 
2098
                              ignore_fallbacks=ignore_fallbacks,
 
2099
                              possible_transports=possible_transports)
 
2100
        except errors.NoSuchFile:
 
2101
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
2102
 
 
2103
    @property
 
2104
    def _matchingbzrdir(self):
 
2105
        ret = bzrdir.BzrDirMetaFormat1()
 
2106
        ret.set_branch_format(self)
 
2107
        return ret
 
2108
 
 
2109
    def supports_tags(self):
 
2110
        return True
 
2111
 
 
2112
    def supports_leaving_lock(self):
 
2113
        return True
 
2114
 
 
2115
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
2116
            basedir=None):
 
2117
        BranchFormat.check_support_status(self,
 
2118
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
2119
            basedir=basedir)
 
2120
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
2121
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
2122
 
 
2123
 
 
2124
class BzrBranchFormat5(BranchFormatMetadir):
1075
2125
    """Bzr branch format 5.
1076
2126
 
1077
2127
    This format has:
1084
2134
    This format is new in bzr 0.8.
1085
2135
    """
1086
2136
 
1087
 
    def get_format_string(self):
 
2137
    def _branch_class(self):
 
2138
        return BzrBranch5
 
2139
 
 
2140
    @classmethod
 
2141
    def get_format_string(cls):
1088
2142
        """See BranchFormat.get_format_string()."""
1089
2143
        return "Bazaar-NG branch format 5\n"
1090
2144
 
1091
2145
    def get_format_description(self):
1092
2146
        """See BranchFormat.get_format_description()."""
1093
2147
        return "Branch format 5"
1094
 
        
1095
 
    def initialize(self, a_bzrdir):
 
2148
 
 
2149
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2150
                   append_revisions_only=None):
1096
2151
        """Create a branch of this format in a_bzrdir."""
 
2152
        if append_revisions_only:
 
2153
            raise errors.UpgradeRequired(a_bzrdir.user_url)
1097
2154
        utf8_files = [('revision-history', ''),
1098
2155
                      ('branch-name', ''),
1099
2156
                      ]
1100
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1101
 
 
1102
 
    def __init__(self):
1103
 
        super(BzrBranchFormat5, self).__init__()
1104
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1105
 
 
1106
 
    def open(self, a_bzrdir, _found=False):
1107
 
        """Return the branch object for a_bzrdir
1108
 
 
1109
 
        _found is a private parameter, do not use it. It is used to indicate
1110
 
               if format probing has already be done.
1111
 
        """
1112
 
        if not _found:
1113
 
            format = BranchFormat.find_format(a_bzrdir)
1114
 
            assert format.__class__ == self.__class__
1115
 
        try:
1116
 
            transport = a_bzrdir.get_branch_transport(None)
1117
 
            control_files = lockable_files.LockableFiles(transport, 'lock',
1118
 
                                                         lockdir.LockDir)
1119
 
            return BzrBranch5(_format=self,
1120
 
                              _control_files=control_files,
1121
 
                              a_bzrdir=a_bzrdir,
1122
 
                              _repository=a_bzrdir.find_repository())
1123
 
        except NoSuchFile:
1124
 
            raise NotBranchError(path=transport.base)
1125
 
 
1126
 
 
1127
 
class BzrBranchFormat6(BzrBranchFormat5):
1128
 
    """Branch format with last-revision
 
2157
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2158
 
 
2159
    def supports_tags(self):
 
2160
        return False
 
2161
 
 
2162
 
 
2163
class BzrBranchFormat6(BranchFormatMetadir):
 
2164
    """Branch format with last-revision and tags.
1129
2165
 
1130
2166
    Unlike previous formats, this has no explicit revision history. Instead,
1131
2167
    this just stores the last-revision, and the left-hand history leading
1132
2168
    up to there is the history.
1133
2169
 
1134
2170
    This format was introduced in bzr 0.15
 
2171
    and became the default in 0.91.
1135
2172
    """
1136
2173
 
1137
 
    def get_format_string(self):
 
2174
    def _branch_class(self):
 
2175
        return BzrBranch6
 
2176
 
 
2177
    @classmethod
 
2178
    def get_format_string(cls):
1138
2179
        """See BranchFormat.get_format_string()."""
1139
2180
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
1140
2181
 
1142
2183
        """See BranchFormat.get_format_description()."""
1143
2184
        return "Branch format 6"
1144
2185
 
1145
 
    def initialize(self, a_bzrdir):
1146
 
        """Create a branch of this format in a_bzrdir."""
1147
 
        utf8_files = [('last-revision', '0 null:\n'),
1148
 
                      ('branch-name', ''),
1149
 
                      ('branch.conf', ''),
1150
 
                      ('tags', ''),
1151
 
                      ]
1152
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1153
 
 
1154
 
    def open(self, a_bzrdir, _found=False):
1155
 
        """Return the branch object for a_bzrdir
1156
 
 
1157
 
        _found is a private parameter, do not use it. It is used to indicate
1158
 
               if format probing has already be done.
1159
 
        """
1160
 
        if not _found:
1161
 
            format = BranchFormat.find_format(a_bzrdir)
1162
 
            assert format.__class__ == self.__class__
1163
 
        transport = a_bzrdir.get_branch_transport(None)
1164
 
        control_files = lockable_files.LockableFiles(transport, 'lock',
1165
 
                                                     lockdir.LockDir)
1166
 
        return BzrBranch6(_format=self,
1167
 
                          _control_files=control_files,
1168
 
                          a_bzrdir=a_bzrdir,
1169
 
                          _repository=a_bzrdir.find_repository())
1170
 
 
1171
 
    def supports_tags(self):
1172
 
        return True
1173
 
 
1174
 
 
1175
 
class BranchReferenceFormat(BranchFormat):
 
2186
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2187
                   append_revisions_only=None):
 
2188
        """Create a branch of this format in a_bzrdir."""
 
2189
        utf8_files = [('last-revision', '0 null:\n'),
 
2190
                      ('branch.conf',
 
2191
                          self._get_initial_config(append_revisions_only)),
 
2192
                      ('tags', ''),
 
2193
                      ]
 
2194
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2195
 
 
2196
    def make_tags(self, branch):
 
2197
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2198
        return _mod_tag.BasicTags(branch)
 
2199
 
 
2200
    def supports_set_append_revisions_only(self):
 
2201
        return True
 
2202
 
 
2203
 
 
2204
class BzrBranchFormat8(BranchFormatMetadir):
 
2205
    """Metadir format supporting storing locations of subtree branches."""
 
2206
 
 
2207
    def _branch_class(self):
 
2208
        return BzrBranch8
 
2209
 
 
2210
    @classmethod
 
2211
    def get_format_string(cls):
 
2212
        """See BranchFormat.get_format_string()."""
 
2213
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
 
2214
 
 
2215
    def get_format_description(self):
 
2216
        """See BranchFormat.get_format_description()."""
 
2217
        return "Branch format 8"
 
2218
 
 
2219
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2220
                   append_revisions_only=None):
 
2221
        """Create a branch of this format in a_bzrdir."""
 
2222
        utf8_files = [('last-revision', '0 null:\n'),
 
2223
                      ('branch.conf',
 
2224
                          self._get_initial_config(append_revisions_only)),
 
2225
                      ('tags', ''),
 
2226
                      ('references', '')
 
2227
                      ]
 
2228
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2229
 
 
2230
    def make_tags(self, branch):
 
2231
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2232
        return _mod_tag.BasicTags(branch)
 
2233
 
 
2234
    def supports_set_append_revisions_only(self):
 
2235
        return True
 
2236
 
 
2237
    def supports_stacking(self):
 
2238
        return True
 
2239
 
 
2240
    supports_reference_locations = True
 
2241
 
 
2242
 
 
2243
class BzrBranchFormat7(BranchFormatMetadir):
 
2244
    """Branch format with last-revision, tags, and a stacked location pointer.
 
2245
 
 
2246
    The stacked location pointer is passed down to the repository and requires
 
2247
    a repository format with supports_external_lookups = True.
 
2248
 
 
2249
    This format was introduced in bzr 1.6.
 
2250
    """
 
2251
 
 
2252
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2253
                   append_revisions_only=None):
 
2254
        """Create a branch of this format in a_bzrdir."""
 
2255
        utf8_files = [('last-revision', '0 null:\n'),
 
2256
                      ('branch.conf',
 
2257
                          self._get_initial_config(append_revisions_only)),
 
2258
                      ('tags', ''),
 
2259
                      ]
 
2260
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2261
 
 
2262
    def _branch_class(self):
 
2263
        return BzrBranch7
 
2264
 
 
2265
    @classmethod
 
2266
    def get_format_string(cls):
 
2267
        """See BranchFormat.get_format_string()."""
 
2268
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
 
2269
 
 
2270
    def get_format_description(self):
 
2271
        """See BranchFormat.get_format_description()."""
 
2272
        return "Branch format 7"
 
2273
 
 
2274
    def supports_set_append_revisions_only(self):
 
2275
        return True
 
2276
 
 
2277
    def supports_stacking(self):
 
2278
        return True
 
2279
 
 
2280
    def make_tags(self, branch):
 
2281
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2282
        return _mod_tag.BasicTags(branch)
 
2283
 
 
2284
    supports_reference_locations = False
 
2285
 
 
2286
 
 
2287
class BranchReferenceFormat(BranchFormatMetadir):
1176
2288
    """Bzr branch reference format.
1177
2289
 
1178
2290
    Branch references are used in implementing checkouts, they
1183
2295
     - a format string
1184
2296
    """
1185
2297
 
1186
 
    def get_format_string(self):
 
2298
    @classmethod
 
2299
    def get_format_string(cls):
1187
2300
        """See BranchFormat.get_format_string()."""
1188
2301
        return "Bazaar-NG Branch Reference Format 1\n"
1189
2302
 
1190
2303
    def get_format_description(self):
1191
2304
        """See BranchFormat.get_format_description()."""
1192
2305
        return "Checkout reference format 1"
1193
 
        
1194
 
    def get_reference(self, a_bzrdir):
 
2306
 
 
2307
    def get_reference(self, a_bzrdir, name=None):
1195
2308
        """See BranchFormat.get_reference()."""
1196
 
        transport = a_bzrdir.get_branch_transport(None)
1197
 
        return transport.get('location').read()
1198
 
 
1199
 
    def initialize(self, a_bzrdir, target_branch=None):
 
2309
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2310
        return transport.get_bytes('location')
 
2311
 
 
2312
    def set_reference(self, a_bzrdir, name, to_branch):
 
2313
        """See BranchFormat.set_reference()."""
 
2314
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2315
        location = transport.put_bytes('location', to_branch.base)
 
2316
 
 
2317
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2318
            repository=None, append_revisions_only=None):
1200
2319
        """Create a branch of this format in a_bzrdir."""
1201
2320
        if target_branch is None:
1202
2321
            # this format does not implement branch itself, thus the implicit
1203
2322
            # creation contract must see it as uninitializable
1204
2323
            raise errors.UninitializableFormat(self)
1205
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1206
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
2324
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2325
        if a_bzrdir._format.fixed_components:
 
2326
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
2327
        if name is None:
 
2328
            name = a_bzrdir._get_selected_branch()
 
2329
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1207
2330
        branch_transport.put_bytes('location',
1208
 
            target_branch.bzrdir.root_transport.base)
1209
 
        branch_transport.put_bytes('format', self.get_format_string())
1210
 
        return self.open(a_bzrdir, _found=True)
1211
 
 
1212
 
    def __init__(self):
1213
 
        super(BranchReferenceFormat, self).__init__()
1214
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
2331
            target_branch.user_url)
 
2332
        branch_transport.put_bytes('format', self.as_string())
 
2333
        branch = self.open(a_bzrdir, name, _found=True,
 
2334
            possible_transports=[target_branch.bzrdir.root_transport])
 
2335
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2336
        return branch
1215
2337
 
1216
2338
    def _make_reference_clone_function(format, a_branch):
1217
2339
        """Create a clone() routine for a branch dynamically."""
1218
 
        def clone(to_bzrdir, revision_id=None):
 
2340
        def clone(to_bzrdir, revision_id=None,
 
2341
            repository_policy=None):
1219
2342
            """See Branch.clone()."""
1220
 
            return format.initialize(to_bzrdir, a_branch)
 
2343
            return format.initialize(to_bzrdir, target_branch=a_branch)
1221
2344
            # cannot obey revision_id limits when cloning a reference ...
1222
2345
            # FIXME RBC 20060210 either nuke revision_id for clone, or
1223
2346
            # emit some sort of warning/error to the caller ?!
1224
2347
        return clone
1225
2348
 
1226
 
    def open(self, a_bzrdir, _found=False, location=None):
 
2349
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2350
             possible_transports=None, ignore_fallbacks=False,
 
2351
             found_repository=None):
1227
2352
        """Return the branch that the branch reference in a_bzrdir points at.
1228
2353
 
1229
 
        _found is a private parameter, do not use it. It is used to indicate
1230
 
               if format probing has already be done.
 
2354
        :param a_bzrdir: A BzrDir that contains a branch.
 
2355
        :param name: Name of colocated branch to open, if any
 
2356
        :param _found: a private parameter, do not use it. It is used to
 
2357
            indicate if format probing has already be done.
 
2358
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
2359
            (if there are any).  Default is to open fallbacks.
 
2360
        :param location: The location of the referenced branch.  If
 
2361
            unspecified, this will be determined from the branch reference in
 
2362
            a_bzrdir.
 
2363
        :param possible_transports: An optional reusable transports list.
1231
2364
        """
 
2365
        if name is None:
 
2366
            name = a_bzrdir._get_selected_branch()
1232
2367
        if not _found:
1233
 
            format = BranchFormat.find_format(a_bzrdir)
1234
 
            assert format.__class__ == self.__class__
 
2368
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
 
2369
            if format.__class__ != self.__class__:
 
2370
                raise AssertionError("wrong format %r found for %r" %
 
2371
                    (format, self))
1235
2372
        if location is None:
1236
 
            location = self.get_reference(a_bzrdir)
1237
 
        real_bzrdir = bzrdir.BzrDir.open(location)
1238
 
        result = real_bzrdir.open_branch()
 
2373
            location = self.get_reference(a_bzrdir, name)
 
2374
        real_bzrdir = controldir.ControlDir.open(
 
2375
            location, possible_transports=possible_transports)
 
2376
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
 
2377
            possible_transports=possible_transports)
1239
2378
        # this changes the behaviour of result.clone to create a new reference
1240
2379
        # rather than a copy of the content of the branch.
1241
2380
        # I did not use a proxy object because that needs much more extensive
1248
2387
        return result
1249
2388
 
1250
2389
 
 
2390
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2391
    """Branch format registry."""
 
2392
 
 
2393
    def __init__(self, other_registry=None):
 
2394
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2395
        self._default_format = None
 
2396
 
 
2397
    def set_default(self, format):
 
2398
        self._default_format = format
 
2399
 
 
2400
    def get_default(self):
 
2401
        return self._default_format
 
2402
 
 
2403
 
 
2404
network_format_registry = registry.FormatRegistry()
 
2405
"""Registry of formats indexed by their network name.
 
2406
 
 
2407
The network name for a branch format is an identifier that can be used when
 
2408
referring to formats with smart server operations. See
 
2409
BranchFormat.network_name() for more detail.
 
2410
"""
 
2411
 
 
2412
format_registry = BranchFormatRegistry(network_format_registry)
 
2413
 
 
2414
 
1251
2415
# formats which have no format string are not discoverable
1252
2416
# and not independently creatable, so are not registered.
1253
 
__default_format = BzrBranchFormat5()
1254
 
BranchFormat.register_format(__default_format)
1255
 
BranchFormat.register_format(BranchReferenceFormat())
1256
 
BranchFormat.register_format(BzrBranchFormat6())
1257
 
BranchFormat.set_default_format(__default_format)
1258
 
_legacy_formats = [BzrBranchFormat4(),
1259
 
                   ]
1260
 
 
1261
 
class BzrBranch(Branch):
 
2417
__format5 = BzrBranchFormat5()
 
2418
__format6 = BzrBranchFormat6()
 
2419
__format7 = BzrBranchFormat7()
 
2420
__format8 = BzrBranchFormat8()
 
2421
format_registry.register(__format5)
 
2422
format_registry.register(BranchReferenceFormat())
 
2423
format_registry.register(__format6)
 
2424
format_registry.register(__format7)
 
2425
format_registry.register(__format8)
 
2426
format_registry.set_default(__format7)
 
2427
 
 
2428
 
 
2429
class BranchWriteLockResult(LogicalLockResult):
 
2430
    """The result of write locking a branch.
 
2431
 
 
2432
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2433
        None.
 
2434
    :ivar unlock: A callable which will unlock the lock.
 
2435
    """
 
2436
 
 
2437
    def __init__(self, unlock, branch_token):
 
2438
        LogicalLockResult.__init__(self, unlock)
 
2439
        self.branch_token = branch_token
 
2440
 
 
2441
    def __repr__(self):
 
2442
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2443
            self.unlock)
 
2444
 
 
2445
 
 
2446
class BzrBranch(Branch, _RelockDebugMixin):
1262
2447
    """A branch stored in the actual filesystem.
1263
2448
 
1264
2449
    Note that it's "local" in the context of the filesystem; it doesn't
1265
2450
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1266
2451
    it's writable, and can be accessed via the normal filesystem API.
 
2452
 
 
2453
    :ivar _transport: Transport for file operations on this branch's
 
2454
        control files, typically pointing to the .bzr/branch directory.
 
2455
    :ivar repository: Repository for this branch.
 
2456
    :ivar base: The url of the base directory for this branch; the one
 
2457
        containing the .bzr directory.
 
2458
    :ivar name: Optional colocated branch name as it exists in the control
 
2459
        directory.
1267
2460
    """
1268
 
    
 
2461
 
1269
2462
    def __init__(self, _format=None,
1270
 
                 _control_files=None, a_bzrdir=None, _repository=None):
 
2463
                 _control_files=None, a_bzrdir=None, name=None,
 
2464
                 _repository=None, ignore_fallbacks=False,
 
2465
                 possible_transports=None):
1271
2466
        """Create new branch object at a particular location."""
1272
 
        Branch.__init__(self)
1273
2467
        if a_bzrdir is None:
1274
2468
            raise ValueError('a_bzrdir must be supplied')
1275
 
        else:
1276
 
            self.bzrdir = a_bzrdir
1277
 
        # self._transport used to point to the directory containing the
1278
 
        # control directory, but was not used - now it's just the transport
1279
 
        # for the branch control files.  mbp 20070212
1280
 
        self._base = self.bzrdir.transport.clone('..').base
 
2469
        if name is None:
 
2470
            raise ValueError('name must be supplied')
 
2471
        self.bzrdir = a_bzrdir
 
2472
        self._user_transport = self.bzrdir.transport.clone('..')
 
2473
        if name != "":
 
2474
            self._user_transport.set_segment_parameter(
 
2475
                "branch", urlutils.escape(name))
 
2476
        self._base = self._user_transport.base
 
2477
        self.name = name
1281
2478
        self._format = _format
1282
2479
        if _control_files is None:
1283
2480
            raise ValueError('BzrBranch _control_files is None')
1284
2481
        self.control_files = _control_files
1285
2482
        self._transport = _control_files._transport
1286
2483
        self.repository = _repository
 
2484
        Branch.__init__(self, possible_transports)
1287
2485
 
1288
2486
    def __str__(self):
1289
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
2487
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
1290
2488
 
1291
2489
    __repr__ = __str__
1292
2490
 
1296
2494
 
1297
2495
    base = property(_get_base, doc="The URL for the root of this branch.")
1298
2496
 
1299
 
    def abspath(self, name):
1300
 
        """See Branch.abspath."""
1301
 
        return self.control_files._transport.abspath(name)
1302
 
 
1303
 
 
1304
 
    @deprecated_method(zero_sixteen)
1305
 
    @needs_read_lock
1306
 
    def get_root_id(self):
1307
 
        """See Branch.get_root_id."""
1308
 
        tree = self.repository.revision_tree(self.last_revision())
1309
 
        return tree.inventory.root.file_id
 
2497
    @property
 
2498
    def user_transport(self):
 
2499
        return self._user_transport
 
2500
 
 
2501
    def _get_config(self):
 
2502
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2503
 
 
2504
    def _get_config_store(self):
 
2505
        return _mod_config.BranchStore(self)
1310
2506
 
1311
2507
    def is_locked(self):
1312
2508
        return self.control_files.is_locked()
1313
2509
 
1314
2510
    def lock_write(self, token=None):
1315
 
        repo_token = self.repository.lock_write()
 
2511
        """Lock the branch for write operations.
 
2512
 
 
2513
        :param token: A token to permit reacquiring a previously held and
 
2514
            preserved lock.
 
2515
        :return: A BranchWriteLockResult.
 
2516
        """
 
2517
        if not self.is_locked():
 
2518
            self._note_lock('w')
 
2519
        # All-in-one needs to always unlock/lock.
 
2520
        repo_control = getattr(self.repository, 'control_files', None)
 
2521
        if self.control_files == repo_control or not self.is_locked():
 
2522
            self.repository._warn_if_deprecated(self)
 
2523
            self.repository.lock_write()
 
2524
            took_lock = True
 
2525
        else:
 
2526
            took_lock = False
1316
2527
        try:
1317
 
            token = self.control_files.lock_write(token=token)
 
2528
            return BranchWriteLockResult(self.unlock,
 
2529
                self.control_files.lock_write(token=token))
1318
2530
        except:
1319
 
            self.repository.unlock()
 
2531
            if took_lock:
 
2532
                self.repository.unlock()
1320
2533
            raise
1321
 
        return token
1322
2534
 
1323
2535
    def lock_read(self):
1324
 
        self.repository.lock_read()
 
2536
        """Lock the branch for read operations.
 
2537
 
 
2538
        :return: A bzrlib.lock.LogicalLockResult.
 
2539
        """
 
2540
        if not self.is_locked():
 
2541
            self._note_lock('r')
 
2542
        # All-in-one needs to always unlock/lock.
 
2543
        repo_control = getattr(self.repository, 'control_files', None)
 
2544
        if self.control_files == repo_control or not self.is_locked():
 
2545
            self.repository._warn_if_deprecated(self)
 
2546
            self.repository.lock_read()
 
2547
            took_lock = True
 
2548
        else:
 
2549
            took_lock = False
1325
2550
        try:
1326
2551
            self.control_files.lock_read()
 
2552
            return LogicalLockResult(self.unlock)
1327
2553
        except:
1328
 
            self.repository.unlock()
 
2554
            if took_lock:
 
2555
                self.repository.unlock()
1329
2556
            raise
1330
2557
 
 
2558
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1331
2559
    def unlock(self):
1332
 
        # TODO: test for failed two phase locks. This is known broken.
1333
2560
        try:
1334
2561
            self.control_files.unlock()
1335
2562
        finally:
1336
 
            self.repository.unlock()
1337
 
        if not self.control_files.is_locked():
1338
 
            # we just released the lock
1339
 
            self._clear_cached_state()
1340
 
        
 
2563
            # All-in-one needs to always unlock/lock.
 
2564
            repo_control = getattr(self.repository, 'control_files', None)
 
2565
            if (self.control_files == repo_control or
 
2566
                not self.control_files.is_locked()):
 
2567
                self.repository.unlock()
 
2568
            if not self.control_files.is_locked():
 
2569
                # we just released the lock
 
2570
                self._clear_cached_state()
 
2571
 
1341
2572
    def peek_lock_mode(self):
1342
2573
        if self.control_files._lock_count == 0:
1343
2574
            return None
1353
2584
        return self.repository.print_file(file, revision_id)
1354
2585
 
1355
2586
    @needs_write_lock
1356
 
    def append_revision(self, *revision_ids):
1357
 
        """See Branch.append_revision."""
1358
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1359
 
        for revision_id in revision_ids:
1360
 
            _mod_revision.check_not_reserved_id(revision_id)
1361
 
            mutter("add {%s} to revision-history" % revision_id)
1362
 
        rev_history = self.revision_history()
1363
 
        rev_history.extend(revision_ids)
1364
 
        self.set_revision_history(rev_history)
1365
 
 
1366
 
    def _write_revision_history(self, history):
1367
 
        """Factored out of set_revision_history.
1368
 
 
1369
 
        This performs the actual writing to disk.
1370
 
        It is intended to be called by BzrBranch5.set_revision_history."""
1371
 
        self.control_files.put_bytes(
1372
 
            'revision-history', '\n'.join(history))
1373
 
 
1374
 
    @needs_write_lock
1375
 
    def set_revision_history(self, rev_history):
1376
 
        """See Branch.set_revision_history."""
1377
 
        rev_history = [osutils.safe_revision_id(r) for r in rev_history]
 
2587
    def set_last_revision_info(self, revno, revision_id):
 
2588
        if not revision_id or not isinstance(revision_id, basestring):
 
2589
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2590
        revision_id = _mod_revision.ensure_null(revision_id)
 
2591
        old_revno, old_revid = self.last_revision_info()
 
2592
        if self.get_append_revisions_only():
 
2593
            self._check_history_violation(revision_id)
 
2594
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2595
        self._write_last_revision_info(revno, revision_id)
1378
2596
        self._clear_cached_state()
1379
 
        self._write_revision_history(rev_history)
1380
 
        self._cache_revision_history(rev_history)
1381
 
        for hook in Branch.hooks['set_rh']:
1382
 
            hook(self, rev_history)
1383
 
 
1384
 
    @needs_write_lock
1385
 
    def set_last_revision_info(self, revno, revision_id):
1386
 
        revision_id = osutils.safe_revision_id(revision_id)
1387
 
        history = self._lefthand_history(revision_id)
1388
 
        assert len(history) == revno, '%d != %d' % (len(history), revno)
1389
 
        self.set_revision_history(history)
1390
 
 
1391
 
    def _gen_revision_history(self):
1392
 
        history = self.control_files.get('revision-history').read().split('\n')
1393
 
        if history[-1:] == ['']:
1394
 
            # There shouldn't be a trailing newline, but just in case.
1395
 
            history.pop()
1396
 
        return history
1397
 
 
1398
 
    def _lefthand_history(self, revision_id, last_rev=None,
1399
 
                          other_branch=None):
1400
 
        # stop_revision must be a descendant of last_revision
1401
 
        stop_graph = self.repository.get_revision_graph(revision_id)
1402
 
        if last_rev is not None and last_rev not in stop_graph:
1403
 
            # our previous tip is not merged into stop_revision
1404
 
            raise errors.DivergedBranches(self, other_branch)
1405
 
        # make a new revision history from the graph
1406
 
        current_rev_id = revision_id
1407
 
        new_history = []
1408
 
        while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1409
 
            new_history.append(current_rev_id)
1410
 
            current_rev_id_parents = stop_graph[current_rev_id]
1411
 
            try:
1412
 
                current_rev_id = current_rev_id_parents[0]
1413
 
            except IndexError:
1414
 
                current_rev_id = None
1415
 
        new_history.reverse()
1416
 
        return new_history
1417
 
 
1418
 
    @needs_write_lock
1419
 
    def generate_revision_history(self, revision_id, last_rev=None,
1420
 
        other_branch=None):
1421
 
        """Create a new revision history that will finish with revision_id.
1422
 
 
1423
 
        :param revision_id: the new tip to use.
1424
 
        :param last_rev: The previous last_revision. If not None, then this
1425
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
1426
 
        :param other_branch: The other branch that DivergedBranches should
1427
 
            raise with respect to.
1428
 
        """
1429
 
        revision_id = osutils.safe_revision_id(revision_id)
1430
 
        self.set_revision_history(self._lefthand_history(revision_id,
1431
 
            last_rev, other_branch))
1432
 
 
1433
 
    @needs_write_lock
1434
 
    def update_revisions(self, other, stop_revision=None):
1435
 
        """See Branch.update_revisions."""
1436
 
        other.lock_read()
1437
 
        try:
1438
 
            if stop_revision is None:
1439
 
                stop_revision = other.last_revision()
1440
 
                if stop_revision is None:
1441
 
                    # if there are no commits, we're done.
1442
 
                    return
1443
 
            else:
1444
 
                stop_revision = osutils.safe_revision_id(stop_revision)
1445
 
            # whats the current last revision, before we fetch [and change it
1446
 
            # possibly]
1447
 
            last_rev = self.last_revision()
1448
 
            # we fetch here regardless of whether we need to so that we pickup
1449
 
            # filled in ghosts.
1450
 
            self.fetch(other, stop_revision)
1451
 
            my_ancestry = self.repository.get_ancestry(last_rev)
1452
 
            if stop_revision in my_ancestry:
1453
 
                # last_revision is a descendant of stop_revision
1454
 
                return
1455
 
            self.generate_revision_history(stop_revision, last_rev=last_rev,
1456
 
                other_branch=other)
1457
 
        finally:
1458
 
            other.unlock()
 
2597
        self._last_revision_info_cache = revno, revision_id
 
2598
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1459
2599
 
1460
2600
    def basis_tree(self):
1461
2601
        """See Branch.basis_tree."""
1462
2602
        return self.repository.revision_tree(self.last_revision())
1463
2603
 
1464
 
    @deprecated_method(zero_eight)
1465
 
    def working_tree(self):
1466
 
        """Create a Working tree object for this branch."""
1467
 
 
1468
 
        from bzrlib.transport.local import LocalTransport
1469
 
        if (self.base.find('://') != -1 or 
1470
 
            not isinstance(self._transport, LocalTransport)):
1471
 
            raise NoWorkingTree(self.base)
1472
 
        return self.bzrdir.open_workingtree()
1473
 
 
1474
 
    @needs_write_lock
1475
 
    def pull(self, source, overwrite=False, stop_revision=None,
1476
 
             _hook_master=None, run_hooks=True):
1477
 
        """See Branch.pull.
1478
 
 
1479
 
        :param _hook_master: Private parameter - set the branch to 
1480
 
            be supplied as the master to push hooks.
1481
 
        :param run_hooks: Private parameter - if false, this branch
1482
 
            is being called because it's the master of the primary branch,
1483
 
            so it should not run its hooks.
1484
 
        """
1485
 
        result = PullResult()
1486
 
        result.source_branch = source
1487
 
        result.target_branch = self
1488
 
        source.lock_read()
1489
 
        try:
1490
 
            result.old_revno, result.old_revid = self.last_revision_info()
1491
 
            try:
1492
 
                self.update_revisions(source, stop_revision)
1493
 
            except DivergedBranches:
1494
 
                if not overwrite:
1495
 
                    raise
1496
 
            if overwrite:
1497
 
                if stop_revision is None:
1498
 
                    stop_revision = source.last_revision()
1499
 
                self.generate_revision_history(stop_revision)
1500
 
            result.tag_conflicts = source.tags.merge_to(self.tags)
1501
 
            result.new_revno, result.new_revid = self.last_revision_info()
1502
 
            if _hook_master:
1503
 
                result.master_branch = _hook_master
1504
 
                result.local_branch = self
1505
 
            else:
1506
 
                result.master_branch = self
1507
 
                result.local_branch = None
1508
 
            if run_hooks:
1509
 
                for hook in Branch.hooks['post_pull']:
1510
 
                    hook(result)
1511
 
        finally:
1512
 
            source.unlock()
1513
 
        return result
1514
 
 
1515
2604
    def _get_parent_location(self):
1516
2605
        _locs = ['parent', 'pull', 'x-pull']
1517
2606
        for l in _locs:
1518
2607
            try:
1519
 
                return self.control_files.get(l).read().strip('\n')
1520
 
            except NoSuchFile:
 
2608
                return self._transport.get_bytes(l).strip('\n')
 
2609
            except errors.NoSuchFile:
1521
2610
                pass
1522
2611
        return None
1523
2612
 
1524
 
    @needs_read_lock
1525
 
    def push(self, target, overwrite=False, stop_revision=None,
1526
 
             _override_hook_source_branch=None):
1527
 
        """See Branch.push.
1528
 
 
1529
 
        This is the basic concrete implementation of push()
1530
 
 
1531
 
        :param _override_hook_source_branch: If specified, run
1532
 
        the hooks passing this Branch as the source, rather than self.  
1533
 
        This is for use of RemoteBranch, where push is delegated to the
1534
 
        underlying vfs-based Branch. 
1535
 
        """
1536
 
        # TODO: Public option to disable running hooks - should be trivial but
1537
 
        # needs tests.
1538
 
        target.lock_write()
1539
 
        try:
1540
 
            result = self._push_with_bound_branches(target, overwrite,
1541
 
                    stop_revision,
1542
 
                    _override_hook_source_branch=_override_hook_source_branch)
1543
 
            return result
1544
 
        finally:
1545
 
            target.unlock()
1546
 
 
1547
 
    def _push_with_bound_branches(self, target, overwrite,
1548
 
            stop_revision,
1549
 
            _override_hook_source_branch=None):
1550
 
        """Push from self into target, and into target's master if any.
1551
 
        
1552
 
        This is on the base BzrBranch class even though it doesn't support 
1553
 
        bound branches because the *target* might be bound.
1554
 
        """
1555
 
        def _run_hooks():
1556
 
            if _override_hook_source_branch:
1557
 
                result.source_branch = _override_hook_source_branch
1558
 
            for hook in Branch.hooks['post_push']:
1559
 
                hook(result)
1560
 
 
1561
 
        bound_location = target.get_bound_location()
1562
 
        if bound_location and target.base != bound_location:
1563
 
            # there is a master branch.
1564
 
            #
1565
 
            # XXX: Why the second check?  Is it even supported for a branch to
1566
 
            # be bound to itself? -- mbp 20070507
1567
 
            master_branch = target.get_master_branch()
1568
 
            master_branch.lock_write()
1569
 
            try:
1570
 
                # push into the master from this branch.
1571
 
                self._basic_push(master_branch, overwrite, stop_revision)
1572
 
                # and push into the target branch from this. Note that we push from
1573
 
                # this branch again, because its considered the highest bandwidth
1574
 
                # repository.
1575
 
                result = self._basic_push(target, overwrite, stop_revision)
1576
 
                result.master_branch = master_branch
1577
 
                result.local_branch = target
1578
 
                _run_hooks()
1579
 
                return result
1580
 
            finally:
1581
 
                master_branch.unlock()
1582
 
        else:
1583
 
            # no master branch
1584
 
            result = self._basic_push(target, overwrite, stop_revision)
1585
 
            # TODO: Why set master_branch and local_branch if there's no
1586
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
1587
 
            # 20070504
1588
 
            result.master_branch = target
1589
 
            result.local_branch = None
1590
 
            _run_hooks()
1591
 
            return result
1592
 
 
1593
 
    def _basic_push(self, target, overwrite, stop_revision):
1594
 
        """Basic implementation of push without bound branches or hooks.
1595
 
 
1596
 
        Must be called with self read locked and target write locked.
1597
 
        """
1598
 
        result = PushResult()
1599
 
        result.source_branch = self
1600
 
        result.target_branch = target
1601
 
        result.old_revno, result.old_revid = target.last_revision_info()
1602
 
        try:
1603
 
            target.update_revisions(self, stop_revision)
1604
 
        except DivergedBranches:
1605
 
            if not overwrite:
1606
 
                raise
1607
 
        if overwrite:
1608
 
            target.set_revision_history(self.revision_history())
1609
 
        result.tag_conflicts = self.tags.merge_to(target.tags)
1610
 
        result.new_revno, result.new_revid = target.last_revision_info()
1611
 
        return result
1612
 
 
1613
 
    def get_parent(self):
1614
 
        """See Branch.get_parent."""
1615
 
 
1616
 
        assert self.base[-1] == '/'
1617
 
        parent = self._get_parent_location()
1618
 
        if parent is None:
1619
 
            return parent
1620
 
        # This is an old-format absolute path to a local branch
1621
 
        # turn it into a url
1622
 
        if parent.startswith('/'):
1623
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1624
 
        try:
1625
 
            return urlutils.join(self.base[:-1], parent)
1626
 
        except errors.InvalidURLJoin, e:
1627
 
            raise errors.InaccessibleParent(parent, self.base)
 
2613
    def get_stacked_on_url(self):
 
2614
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
1628
2615
 
1629
2616
    def set_push_location(self, location):
1630
2617
        """See Branch.set_push_location."""
1632
2619
            'push_location', location,
1633
2620
            store=_mod_config.STORE_LOCATION_NORECURSE)
1634
2621
 
1635
 
    @needs_write_lock
1636
 
    def set_parent(self, url):
1637
 
        """See Branch.set_parent."""
1638
 
        # TODO: Maybe delete old location files?
1639
 
        # URLs should never be unicode, even on the local fs,
1640
 
        # FIXUP this and get_parent in a future branch format bump:
1641
 
        # read and rewrite the file, and have the new format code read
1642
 
        # using .get not .get_utf8. RBC 20060125
1643
 
        if url is not None:
1644
 
            if isinstance(url, unicode):
1645
 
                try: 
1646
 
                    url = url.encode('ascii')
1647
 
                except UnicodeEncodeError:
1648
 
                    raise errors.InvalidURL(url,
1649
 
                        "Urls must be 7-bit ascii, "
1650
 
                        "use bzrlib.urlutils.escape")
1651
 
            url = urlutils.relative_url(self.base, url)
1652
 
        self._set_parent_location(url)
1653
 
 
1654
2622
    def _set_parent_location(self, url):
1655
2623
        if url is None:
1656
 
            self.control_files._transport.delete('parent')
1657
 
        else:
1658
 
            assert isinstance(url, str)
1659
 
            self.control_files.put_bytes('parent', url + '\n')
1660
 
 
1661
 
    @deprecated_function(zero_nine)
1662
 
    def tree_config(self):
1663
 
        """DEPRECATED; call get_config instead.  
1664
 
        TreeConfig has become part of BranchConfig."""
1665
 
        return TreeConfig(self)
1666
 
 
1667
 
 
1668
 
class BzrBranch5(BzrBranch):
1669
 
    """A format 5 branch. This supports new features over plan branches.
1670
 
 
1671
 
    It has support for a master_branch which is the data for bound branches.
1672
 
    """
1673
 
 
1674
 
    def __init__(self,
1675
 
                 _format,
1676
 
                 _control_files,
1677
 
                 a_bzrdir,
1678
 
                 _repository):
1679
 
        super(BzrBranch5, self).__init__(_format=_format,
1680
 
                                         _control_files=_control_files,
1681
 
                                         a_bzrdir=a_bzrdir,
1682
 
                                         _repository=_repository)
1683
 
        
1684
 
    @needs_write_lock
1685
 
    def pull(self, source, overwrite=False, stop_revision=None,
1686
 
             run_hooks=True):
1687
 
        """Pull from source into self, updating my master if any.
1688
 
        
1689
 
        :param run_hooks: Private parameter - if false, this branch
1690
 
            is being called because it's the master of the primary branch,
1691
 
            so it should not run its hooks.
1692
 
        """
1693
 
        bound_location = self.get_bound_location()
1694
 
        master_branch = None
1695
 
        if bound_location and source.base != bound_location:
1696
 
            # not pulling from master, so we need to update master.
1697
 
            master_branch = self.get_master_branch()
1698
 
            master_branch.lock_write()
1699
 
        try:
1700
 
            if master_branch:
1701
 
                # pull from source into master.
1702
 
                master_branch.pull(source, overwrite, stop_revision,
1703
 
                    run_hooks=False)
1704
 
            return super(BzrBranch5, self).pull(source, overwrite,
1705
 
                stop_revision, _hook_master=master_branch,
1706
 
                run_hooks=run_hooks)
1707
 
        finally:
1708
 
            if master_branch:
1709
 
                master_branch.unlock()
1710
 
 
1711
 
    def get_bound_location(self):
1712
 
        try:
1713
 
            return self.control_files.get_utf8('bound').read()[:-1]
1714
 
        except errors.NoSuchFile:
1715
 
            return None
1716
 
 
1717
 
    @needs_read_lock
1718
 
    def get_master_branch(self):
1719
 
        """Return the branch we are bound to.
1720
 
        
1721
 
        :return: Either a Branch, or None
1722
 
 
1723
 
        This could memoise the branch, but if thats done
1724
 
        it must be revalidated on each new lock.
1725
 
        So for now we just don't memoise it.
1726
 
        # RBC 20060304 review this decision.
1727
 
        """
1728
 
        bound_loc = self.get_bound_location()
1729
 
        if not bound_loc:
1730
 
            return None
1731
 
        try:
1732
 
            return Branch.open(bound_loc)
1733
 
        except (errors.NotBranchError, errors.ConnectionError), e:
1734
 
            raise errors.BoundBranchConnectionFailure(
1735
 
                    self, bound_loc, e)
1736
 
 
1737
 
    @needs_write_lock
1738
 
    def set_bound_location(self, location):
1739
 
        """Set the target where this branch is bound to.
1740
 
 
1741
 
        :param location: URL to the target branch
1742
 
        """
1743
 
        if location:
1744
 
            self.control_files.put_utf8('bound', location+'\n')
1745
 
        else:
1746
 
            try:
1747
 
                self.control_files._transport.delete('bound')
1748
 
            except NoSuchFile:
1749
 
                return False
1750
 
            return True
 
2624
            self._transport.delete('parent')
 
2625
        else:
 
2626
            self._transport.put_bytes('parent', url + '\n',
 
2627
                mode=self.bzrdir._get_file_mode())
 
2628
 
 
2629
    @needs_write_lock
 
2630
    def unbind(self):
 
2631
        """If bound, unbind"""
 
2632
        return self.set_bound_location(None)
1751
2633
 
1752
2634
    @needs_write_lock
1753
2635
    def bind(self, other):
1757
2639
        check for divergence to raise an error when the branches are not
1758
2640
        either the same, or one a prefix of the other. That behaviour may not
1759
2641
        be useful, so that check may be removed in future.
1760
 
        
 
2642
 
1761
2643
        :param other: The branch to bind to
1762
2644
        :type other: Branch
1763
2645
        """
1773
2655
        # last_rev is not in the other_last_rev history, AND
1774
2656
        # other_last_rev is not in our history, and do it without pulling
1775
2657
        # history around
1776
 
        last_rev = self.last_revision()
1777
 
        if last_rev is not None:
1778
 
            other.lock_read()
1779
 
            try:
1780
 
                other_last_rev = other.last_revision()
1781
 
                if other_last_rev is not None:
1782
 
                    # neither branch is new, we have to do some work to
1783
 
                    # ascertain diversion.
1784
 
                    remote_graph = other.repository.get_revision_graph(
1785
 
                        other_last_rev)
1786
 
                    local_graph = self.repository.get_revision_graph(last_rev)
1787
 
                    if (last_rev not in remote_graph and
1788
 
                        other_last_rev not in local_graph):
1789
 
                        raise errors.DivergedBranches(self, other)
1790
 
            finally:
1791
 
                other.unlock()
1792
2658
        self.set_bound_location(other.base)
1793
2659
 
1794
 
    @needs_write_lock
1795
 
    def unbind(self):
1796
 
        """If bound, unbind"""
1797
 
        return self.set_bound_location(None)
1798
 
 
1799
 
    @needs_write_lock
1800
 
    def update(self):
1801
 
        """Synchronise this branch with the master branch if any. 
 
2660
    def get_bound_location(self):
 
2661
        try:
 
2662
            return self._transport.get_bytes('bound')[:-1]
 
2663
        except errors.NoSuchFile:
 
2664
            return None
 
2665
 
 
2666
    @needs_read_lock
 
2667
    def get_master_branch(self, possible_transports=None):
 
2668
        """Return the branch we are bound to.
 
2669
 
 
2670
        :return: Either a Branch, or None
 
2671
        """
 
2672
        if self._master_branch_cache is None:
 
2673
            self._master_branch_cache = self._get_master_branch(
 
2674
                possible_transports)
 
2675
        return self._master_branch_cache
 
2676
 
 
2677
    def _get_master_branch(self, possible_transports):
 
2678
        bound_loc = self.get_bound_location()
 
2679
        if not bound_loc:
 
2680
            return None
 
2681
        try:
 
2682
            return Branch.open(bound_loc,
 
2683
                               possible_transports=possible_transports)
 
2684
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2685
            raise errors.BoundBranchConnectionFailure(
 
2686
                    self, bound_loc, e)
 
2687
 
 
2688
    @needs_write_lock
 
2689
    def set_bound_location(self, location):
 
2690
        """Set the target where this branch is bound to.
 
2691
 
 
2692
        :param location: URL to the target branch
 
2693
        """
 
2694
        self._master_branch_cache = None
 
2695
        if location:
 
2696
            self._transport.put_bytes('bound', location+'\n',
 
2697
                mode=self.bzrdir._get_file_mode())
 
2698
        else:
 
2699
            try:
 
2700
                self._transport.delete('bound')
 
2701
            except errors.NoSuchFile:
 
2702
                return False
 
2703
            return True
 
2704
 
 
2705
    @needs_write_lock
 
2706
    def update(self, possible_transports=None):
 
2707
        """Synchronise this branch with the master branch if any.
1802
2708
 
1803
2709
        :return: None or the last_revision that was pivoted out during the
1804
2710
                 update.
1805
2711
        """
1806
 
        master = self.get_master_branch()
 
2712
        master = self.get_master_branch(possible_transports)
1807
2713
        if master is not None:
1808
 
            old_tip = self.last_revision()
 
2714
            old_tip = _mod_revision.ensure_null(self.last_revision())
1809
2715
            self.pull(master, overwrite=True)
1810
 
            if old_tip in self.repository.get_ancestry(self.last_revision()):
 
2716
            if self.repository.get_graph().is_ancestor(old_tip,
 
2717
                _mod_revision.ensure_null(self.last_revision())):
1811
2718
                return None
1812
2719
            return old_tip
1813
2720
        return None
1814
2721
 
1815
 
 
1816
 
class BzrBranchExperimental(BzrBranch5):
1817
 
    """Bzr experimental branch format
1818
 
 
1819
 
    This format has:
1820
 
     - a revision-history file.
1821
 
     - a format string
1822
 
     - a lock dir guarding the branch itself
1823
 
     - all of this stored in a branch/ subdirectory
1824
 
     - works with shared repositories.
1825
 
     - a tag dictionary in the branch
1826
 
 
1827
 
    This format is new in bzr 0.15, but shouldn't be used for real data, 
1828
 
    only for testing.
1829
 
 
1830
 
    This class acts as it's own BranchFormat.
1831
 
    """
1832
 
 
1833
 
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1834
 
 
1835
 
    @classmethod
1836
 
    def get_format_string(cls):
1837
 
        """See BranchFormat.get_format_string()."""
1838
 
        return "Bazaar-NG branch format experimental\n"
1839
 
 
1840
 
    @classmethod
1841
 
    def get_format_description(cls):
1842
 
        """See BranchFormat.get_format_description()."""
1843
 
        return "Experimental branch format"
1844
 
 
1845
 
    @classmethod
1846
 
    def get_reference(cls, a_bzrdir):
1847
 
        """Get the target reference of the branch in a_bzrdir.
1848
 
 
1849
 
        format probing must have been completed before calling
1850
 
        this method - it is assumed that the format of the branch
1851
 
        in a_bzrdir is correct.
1852
 
 
1853
 
        :param a_bzrdir: The bzrdir to get the branch data from.
1854
 
        :return: None if the branch is not a reference branch.
1855
 
        """
1856
 
        return None
1857
 
 
1858
 
    @classmethod
1859
 
    def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1860
 
            lock_class):
1861
 
        branch_transport = a_bzrdir.get_branch_transport(cls)
1862
 
        control_files = lockable_files.LockableFiles(branch_transport,
1863
 
            lock_filename, lock_class)
1864
 
        control_files.create_lock()
1865
 
        control_files.lock_write()
1866
 
        try:
1867
 
            for filename, content in utf8_files:
1868
 
                control_files.put_utf8(filename, content)
1869
 
        finally:
1870
 
            control_files.unlock()
1871
 
        
1872
 
    @classmethod
1873
 
    def initialize(cls, a_bzrdir):
1874
 
        """Create a branch of this format in a_bzrdir."""
1875
 
        utf8_files = [('format', cls.get_format_string()),
1876
 
                      ('revision-history', ''),
1877
 
                      ('branch-name', ''),
1878
 
                      ('tags', ''),
1879
 
                      ]
1880
 
        cls._initialize_control_files(a_bzrdir, utf8_files,
1881
 
            'lock', lockdir.LockDir)
1882
 
        return cls.open(a_bzrdir, _found=True)
1883
 
 
1884
 
    @classmethod
1885
 
    def open(cls, a_bzrdir, _found=False):
1886
 
        """Return the branch object for a_bzrdir
1887
 
 
1888
 
        _found is a private parameter, do not use it. It is used to indicate
1889
 
               if format probing has already be done.
1890
 
        """
1891
 
        if not _found:
1892
 
            format = BranchFormat.find_format(a_bzrdir)
1893
 
            assert format.__class__ == cls
1894
 
        transport = a_bzrdir.get_branch_transport(None)
1895
 
        control_files = lockable_files.LockableFiles(transport, 'lock',
1896
 
                                                     lockdir.LockDir)
1897
 
        return cls(_format=cls,
1898
 
            _control_files=control_files,
1899
 
            a_bzrdir=a_bzrdir,
1900
 
            _repository=a_bzrdir.find_repository())
1901
 
 
1902
 
    @classmethod
1903
 
    def is_supported(cls):
1904
 
        return True
1905
 
 
1906
 
    def _make_tags(self):
1907
 
        return BasicTags(self)
1908
 
 
1909
 
    @classmethod
1910
 
    def supports_tags(cls):
1911
 
        return True
1912
 
 
1913
 
 
1914
 
BranchFormat.register_format(BzrBranchExperimental)
1915
 
 
1916
 
 
1917
 
class BzrBranch6(BzrBranch5):
1918
 
 
1919
 
    @needs_read_lock
1920
 
    def last_revision_info(self):
1921
 
        revision_string = self.control_files.get('last-revision').read()
 
2722
    def _read_last_revision_info(self):
 
2723
        revision_string = self._transport.get_bytes('last-revision')
1922
2724
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1923
2725
        revision_id = cache_utf8.get_cached_utf8(revision_id)
1924
2726
        revno = int(revno)
1925
2727
        return revno, revision_id
1926
2728
 
1927
 
    def last_revision(self):
1928
 
        """Return last revision id, or None"""
1929
 
        revision_id = self.last_revision_info()[1]
1930
 
        if revision_id == _mod_revision.NULL_REVISION:
1931
 
            revision_id = None
1932
 
        return revision_id
1933
 
 
1934
2729
    def _write_last_revision_info(self, revno, revision_id):
1935
2730
        """Simply write out the revision id, with no checks.
1936
2731
 
1937
2732
        Use set_last_revision_info to perform this safely.
1938
2733
 
1939
2734
        Does not update the revision_history cache.
1940
 
        Intended to be called by set_last_revision_info and
1941
 
        _write_revision_history.
1942
2735
        """
1943
 
        if revision_id is None:
1944
 
            revision_id = 'null:'
 
2736
        revision_id = _mod_revision.ensure_null(revision_id)
1945
2737
        out_string = '%d %s\n' % (revno, revision_id)
1946
 
        self.control_files.put_bytes('last-revision', out_string)
 
2738
        self._transport.put_bytes('last-revision', out_string,
 
2739
            mode=self.bzrdir._get_file_mode())
 
2740
 
 
2741
    @needs_write_lock
 
2742
    def update_feature_flags(self, updated_flags):
 
2743
        """Update the feature flags for this branch.
 
2744
 
 
2745
        :param updated_flags: Dictionary mapping feature names to necessities
 
2746
            A necessity can be None to indicate the feature should be removed
 
2747
        """
 
2748
        self._format._update_feature_flags(updated_flags)
 
2749
        self.control_transport.put_bytes('format', self._format.as_string())
 
2750
 
 
2751
 
 
2752
class FullHistoryBzrBranch(BzrBranch):
 
2753
    """Bzr branch which contains the full revision history."""
1947
2754
 
1948
2755
    @needs_write_lock
1949
2756
    def set_last_revision_info(self, revno, revision_id):
1950
 
        revision_id = osutils.safe_revision_id(revision_id)
1951
 
        if self._get_append_revisions_only():
1952
 
            self._check_history_violation(revision_id)
1953
 
        self._write_last_revision_info(revno, revision_id)
 
2757
        if not revision_id or not isinstance(revision_id, basestring):
 
2758
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2759
        revision_id = _mod_revision.ensure_null(revision_id)
 
2760
        # this old format stores the full history, but this api doesn't
 
2761
        # provide it, so we must generate, and might as well check it's
 
2762
        # correct
 
2763
        history = self._lefthand_history(revision_id)
 
2764
        if len(history) != revno:
 
2765
            raise AssertionError('%d != %d' % (len(history), revno))
 
2766
        self._set_revision_history(history)
 
2767
 
 
2768
    def _read_last_revision_info(self):
 
2769
        rh = self._revision_history()
 
2770
        revno = len(rh)
 
2771
        if revno:
 
2772
            return (revno, rh[-1])
 
2773
        else:
 
2774
            return (0, _mod_revision.NULL_REVISION)
 
2775
 
 
2776
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2777
    @needs_write_lock
 
2778
    def set_revision_history(self, rev_history):
 
2779
        """See Branch.set_revision_history."""
 
2780
        self._set_revision_history(rev_history)
 
2781
 
 
2782
    def _set_revision_history(self, rev_history):
 
2783
        if 'evil' in debug.debug_flags:
 
2784
            mutter_callsite(3, "set_revision_history scales with history.")
 
2785
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2786
        for rev_id in rev_history:
 
2787
            check_not_reserved_id(rev_id)
 
2788
        if Branch.hooks['post_change_branch_tip']:
 
2789
            # Don't calculate the last_revision_info() if there are no hooks
 
2790
            # that will use it.
 
2791
            old_revno, old_revid = self.last_revision_info()
 
2792
        if len(rev_history) == 0:
 
2793
            revid = _mod_revision.NULL_REVISION
 
2794
        else:
 
2795
            revid = rev_history[-1]
 
2796
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2797
        self._write_revision_history(rev_history)
1954
2798
        self._clear_cached_state()
 
2799
        self._cache_revision_history(rev_history)
 
2800
        for hook in Branch.hooks['set_rh']:
 
2801
            hook(self, rev_history)
 
2802
        if Branch.hooks['post_change_branch_tip']:
 
2803
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2804
 
 
2805
    def _write_revision_history(self, history):
 
2806
        """Factored out of set_revision_history.
 
2807
 
 
2808
        This performs the actual writing to disk.
 
2809
        It is intended to be called by set_revision_history."""
 
2810
        self._transport.put_bytes(
 
2811
            'revision-history', '\n'.join(history),
 
2812
            mode=self.bzrdir._get_file_mode())
 
2813
 
 
2814
    def _gen_revision_history(self):
 
2815
        history = self._transport.get_bytes('revision-history').split('\n')
 
2816
        if history[-1:] == ['']:
 
2817
            # There shouldn't be a trailing newline, but just in case.
 
2818
            history.pop()
 
2819
        return history
 
2820
 
 
2821
    def _synchronize_history(self, destination, revision_id):
 
2822
        if not isinstance(destination, FullHistoryBzrBranch):
 
2823
            super(BzrBranch, self)._synchronize_history(
 
2824
                destination, revision_id)
 
2825
            return
 
2826
        if revision_id == _mod_revision.NULL_REVISION:
 
2827
            new_history = []
 
2828
        else:
 
2829
            new_history = self._revision_history()
 
2830
        if revision_id is not None and new_history != []:
 
2831
            try:
 
2832
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2833
            except ValueError:
 
2834
                rev = self.repository.get_revision(revision_id)
 
2835
                new_history = rev.get_history(self.repository)[1:]
 
2836
        destination._set_revision_history(new_history)
 
2837
 
 
2838
    @needs_write_lock
 
2839
    def generate_revision_history(self, revision_id, last_rev=None,
 
2840
        other_branch=None):
 
2841
        """Create a new revision history that will finish with revision_id.
 
2842
 
 
2843
        :param revision_id: the new tip to use.
 
2844
        :param last_rev: The previous last_revision. If not None, then this
 
2845
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2846
        :param other_branch: The other branch that DivergedBranches should
 
2847
            raise with respect to.
 
2848
        """
 
2849
        self._set_revision_history(self._lefthand_history(revision_id,
 
2850
            last_rev, other_branch))
 
2851
 
 
2852
 
 
2853
class BzrBranch5(FullHistoryBzrBranch):
 
2854
    """A format 5 branch. This supports new features over plain branches.
 
2855
 
 
2856
    It has support for a master_branch which is the data for bound branches.
 
2857
    """
 
2858
 
 
2859
 
 
2860
class BzrBranch8(BzrBranch):
 
2861
    """A branch that stores tree-reference locations."""
 
2862
 
 
2863
    def _open_hook(self, possible_transports=None):
 
2864
        if self._ignore_fallbacks:
 
2865
            return
 
2866
        if possible_transports is None:
 
2867
            possible_transports = [self.bzrdir.root_transport]
 
2868
        try:
 
2869
            url = self.get_stacked_on_url()
 
2870
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
 
2871
            errors.UnstackableBranchFormat):
 
2872
            pass
 
2873
        else:
 
2874
            for hook in Branch.hooks['transform_fallback_location']:
 
2875
                url = hook(self, url)
 
2876
                if url is None:
 
2877
                    hook_name = Branch.hooks.get_hook_name(hook)
 
2878
                    raise AssertionError(
 
2879
                        "'transform_fallback_location' hook %s returned "
 
2880
                        "None, not a URL." % hook_name)
 
2881
            self._activate_fallback_location(url,
 
2882
                possible_transports=possible_transports)
 
2883
 
 
2884
    def __init__(self, *args, **kwargs):
 
2885
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
 
2886
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2887
        self._last_revision_info_cache = None
 
2888
        self._reference_info = None
 
2889
 
 
2890
    def _clear_cached_state(self):
 
2891
        super(BzrBranch8, self)._clear_cached_state()
 
2892
        self._last_revision_info_cache = None
 
2893
        self._reference_info = None
1955
2894
 
1956
2895
    def _check_history_violation(self, revision_id):
1957
 
        last_revision = self.last_revision()
1958
 
        if last_revision is None:
 
2896
        current_revid = self.last_revision()
 
2897
        last_revision = _mod_revision.ensure_null(current_revid)
 
2898
        if _mod_revision.is_null(last_revision):
1959
2899
            return
1960
 
        if last_revision not in self._lefthand_history(revision_id):
1961
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2900
        graph = self.repository.get_graph()
 
2901
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2902
            if lh_ancestor == current_revid:
 
2903
                return
 
2904
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
1962
2905
 
1963
2906
    def _gen_revision_history(self):
1964
2907
        """Generate the revision history from last revision
1965
2908
        """
1966
 
        history = list(self.repository.iter_reverse_revision_history(
1967
 
            self.last_revision()))
1968
 
        history.reverse()
1969
 
        return history
1970
 
 
1971
 
    def _write_revision_history(self, history):
1972
 
        """Factored out of set_revision_history.
1973
 
 
1974
 
        This performs the actual writing to disk, with format-specific checks.
1975
 
        It is intended to be called by BzrBranch5.set_revision_history.
1976
 
        """
1977
 
        if len(history) == 0:
1978
 
            last_revision = 'null:'
1979
 
        else:
1980
 
            if history != self._lefthand_history(history[-1]):
1981
 
                raise errors.NotLefthandHistory(history)
1982
 
            last_revision = history[-1]
1983
 
        if self._get_append_revisions_only():
1984
 
            self._check_history_violation(last_revision)
1985
 
        self._write_last_revision_info(len(history), last_revision)
1986
 
 
1987
 
    @needs_write_lock
1988
 
    def append_revision(self, *revision_ids):
1989
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1990
 
        if len(revision_ids) == 0:
1991
 
            return
1992
 
        prev_revno, prev_revision = self.last_revision_info()
1993
 
        for revision in self.repository.get_revisions(revision_ids):
1994
 
            if prev_revision == _mod_revision.NULL_REVISION:
1995
 
                if revision.parent_ids != []:
1996
 
                    raise errors.NotLeftParentDescendant(self, prev_revision,
1997
 
                                                         revision.revision_id)
1998
 
            else:
1999
 
                if revision.parent_ids[0] != prev_revision:
2000
 
                    raise errors.NotLeftParentDescendant(self, prev_revision,
2001
 
                                                         revision.revision_id)
2002
 
            prev_revision = revision.revision_id
2003
 
        self.set_last_revision_info(prev_revno + len(revision_ids),
2004
 
                                    revision_ids[-1])
 
2909
        last_revno, last_revision = self.last_revision_info()
 
2910
        self._extend_partial_history(stop_index=last_revno-1)
 
2911
        return list(reversed(self._partial_revision_history_cache))
2005
2912
 
2006
2913
    @needs_write_lock
2007
2914
    def _set_parent_location(self, url):
2013
2920
        """Set the parent branch"""
2014
2921
        return self._get_config_location('parent_location')
2015
2922
 
 
2923
    @needs_write_lock
 
2924
    def _set_all_reference_info(self, info_dict):
 
2925
        """Replace all reference info stored in a branch.
 
2926
 
 
2927
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
 
2928
        """
 
2929
        s = StringIO()
 
2930
        writer = rio.RioWriter(s)
 
2931
        for key, (tree_path, branch_location) in info_dict.iteritems():
 
2932
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
 
2933
                                branch_location=branch_location)
 
2934
            writer.write_stanza(stanza)
 
2935
        self._transport.put_bytes('references', s.getvalue())
 
2936
        self._reference_info = info_dict
 
2937
 
 
2938
    @needs_read_lock
 
2939
    def _get_all_reference_info(self):
 
2940
        """Return all the reference info stored in a branch.
 
2941
 
 
2942
        :return: A dict of {file_id: (tree_path, branch_location)}
 
2943
        """
 
2944
        if self._reference_info is not None:
 
2945
            return self._reference_info
 
2946
        rio_file = self._transport.get('references')
 
2947
        try:
 
2948
            stanzas = rio.read_stanzas(rio_file)
 
2949
            info_dict = dict((s['file_id'], (s['tree_path'],
 
2950
                             s['branch_location'])) for s in stanzas)
 
2951
        finally:
 
2952
            rio_file.close()
 
2953
        self._reference_info = info_dict
 
2954
        return info_dict
 
2955
 
 
2956
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2957
        """Set the branch location to use for a tree reference.
 
2958
 
 
2959
        :param file_id: The file-id of the tree reference.
 
2960
        :param tree_path: The path of the tree reference in the tree.
 
2961
        :param branch_location: The location of the branch to retrieve tree
 
2962
            references from.
 
2963
        """
 
2964
        info_dict = self._get_all_reference_info()
 
2965
        info_dict[file_id] = (tree_path, branch_location)
 
2966
        if None in (tree_path, branch_location):
 
2967
            if tree_path is not None:
 
2968
                raise ValueError('tree_path must be None when branch_location'
 
2969
                                 ' is None.')
 
2970
            if branch_location is not None:
 
2971
                raise ValueError('branch_location must be None when tree_path'
 
2972
                                 ' is None.')
 
2973
            del info_dict[file_id]
 
2974
        self._set_all_reference_info(info_dict)
 
2975
 
 
2976
    def get_reference_info(self, file_id):
 
2977
        """Get the tree_path and branch_location for a tree reference.
 
2978
 
 
2979
        :return: a tuple of (tree_path, branch_location)
 
2980
        """
 
2981
        return self._get_all_reference_info().get(file_id, (None, None))
 
2982
 
 
2983
    def reference_parent(self, file_id, path, possible_transports=None):
 
2984
        """Return the parent branch for a tree-reference file_id.
 
2985
 
 
2986
        :param file_id: The file_id of the tree reference
 
2987
        :param path: The path of the file_id in the tree
 
2988
        :return: A branch associated with the file_id
 
2989
        """
 
2990
        branch_location = self.get_reference_info(file_id)[1]
 
2991
        if branch_location is None:
 
2992
            return Branch.reference_parent(self, file_id, path,
 
2993
                                           possible_transports)
 
2994
        branch_location = urlutils.join(self.user_url, branch_location)
 
2995
        return Branch.open(branch_location,
 
2996
                           possible_transports=possible_transports)
 
2997
 
2016
2998
    def set_push_location(self, location):
2017
2999
        """See Branch.set_push_location."""
2018
3000
        self._set_config_location('push_location', location)
2019
3001
 
2020
3002
    def set_bound_location(self, location):
2021
3003
        """See Branch.set_push_location."""
 
3004
        self._master_branch_cache = None
2022
3005
        result = None
2023
 
        config = self.get_config()
 
3006
        conf = self.get_config_stack()
2024
3007
        if location is None:
2025
 
            if config.get_user_option('bound') != 'True':
 
3008
            if not conf.get('bound'):
2026
3009
                return False
2027
3010
            else:
2028
 
                config.set_user_option('bound', 'False')
 
3011
                conf.set('bound', 'False')
2029
3012
                return True
2030
3013
        else:
2031
3014
            self._set_config_location('bound_location', location,
2032
 
                                      config=config)
2033
 
            config.set_user_option('bound', 'True')
 
3015
                                      config=conf)
 
3016
            conf.set('bound', 'True')
2034
3017
        return True
2035
3018
 
2036
3019
    def _get_bound_location(self, bound):
2037
3020
        """Return the bound location in the config file.
2038
3021
 
2039
3022
        Return None if the bound parameter does not match"""
2040
 
        config = self.get_config()
2041
 
        config_bound = (config.get_user_option('bound') == 'True')
2042
 
        if config_bound != bound:
 
3023
        conf = self.get_config_stack()
 
3024
        if conf.get('bound') != bound:
2043
3025
            return None
2044
 
        return self._get_config_location('bound_location', config=config)
 
3026
        return self._get_config_location('bound_location', config=conf)
2045
3027
 
2046
3028
    def get_bound_location(self):
2047
 
        """See Branch.set_push_location."""
 
3029
        """See Branch.get_bound_location."""
2048
3030
        return self._get_bound_location(True)
2049
3031
 
2050
3032
    def get_old_bound_location(self):
2051
3033
        """See Branch.get_old_bound_location"""
2052
3034
        return self._get_bound_location(False)
2053
3035
 
2054
 
    def set_append_revisions_only(self, enabled):
2055
 
        if enabled:
2056
 
            value = 'True'
2057
 
        else:
2058
 
            value = 'False'
2059
 
        self.get_config().set_user_option('append_revisions_only', value)
2060
 
 
2061
 
    def _get_append_revisions_only(self):
2062
 
        value = self.get_config().get_user_option('append_revisions_only')
2063
 
        return value == 'True'
2064
 
 
2065
 
    def _synchronize_history(self, destination, revision_id):
2066
 
        """Synchronize last revision and revision history between branches.
2067
 
 
2068
 
        This version is most efficient when the destination is also a
2069
 
        BzrBranch6, but works for BzrBranch5, as long as the destination's
2070
 
        repository contains all the lefthand ancestors of the intended
2071
 
        last_revision.  If not, set_last_revision_info will fail.
2072
 
 
2073
 
        :param destination: The branch to copy the history into
2074
 
        :param revision_id: The revision-id to truncate history at.  May
2075
 
          be None to copy complete history.
2076
 
        """
2077
 
        if revision_id is None:
2078
 
            revno, revision_id = self.last_revision_info()
2079
 
        else:
2080
 
            revno = self.revision_id_to_revno(revision_id)
2081
 
        destination.set_last_revision_info(revno, revision_id)
2082
 
 
2083
 
    def _make_tags(self):
2084
 
        return BasicTags(self)
2085
 
 
2086
 
 
2087
 
class BranchTestProviderAdapter(object):
2088
 
    """A tool to generate a suite testing multiple branch formats at once.
2089
 
 
2090
 
    This is done by copying the test once for each transport and injecting
2091
 
    the transport_server, transport_readonly_server, and branch_format
2092
 
    classes into each copy. Each copy is also given a new id() to make it
2093
 
    easy to identify.
 
3036
    def get_stacked_on_url(self):
 
3037
        # you can always ask for the URL; but you might not be able to use it
 
3038
        # if the repo can't support stacking.
 
3039
        ## self._check_stackable_repo()
 
3040
        # stacked_on_location is only ever defined in branch.conf, so don't
 
3041
        # waste effort reading the whole stack of config files.
 
3042
        conf = _mod_config.BranchOnlyStack(self)
 
3043
        stacked_url = self._get_config_location('stacked_on_location',
 
3044
                                                config=conf)
 
3045
        if stacked_url is None:
 
3046
            raise errors.NotStacked(self)
 
3047
        return stacked_url.encode('utf-8')
 
3048
 
 
3049
    @needs_read_lock
 
3050
    def get_rev_id(self, revno, history=None):
 
3051
        """Find the revision id of the specified revno."""
 
3052
        if revno == 0:
 
3053
            return _mod_revision.NULL_REVISION
 
3054
 
 
3055
        last_revno, last_revision_id = self.last_revision_info()
 
3056
        if revno <= 0 or revno > last_revno:
 
3057
            raise errors.NoSuchRevision(self, revno)
 
3058
 
 
3059
        if history is not None:
 
3060
            return history[revno - 1]
 
3061
 
 
3062
        index = last_revno - revno
 
3063
        if len(self._partial_revision_history_cache) <= index:
 
3064
            self._extend_partial_history(stop_index=index)
 
3065
        if len(self._partial_revision_history_cache) > index:
 
3066
            return self._partial_revision_history_cache[index]
 
3067
        else:
 
3068
            raise errors.NoSuchRevision(self, revno)
 
3069
 
 
3070
    @needs_read_lock
 
3071
    def revision_id_to_revno(self, revision_id):
 
3072
        """Given a revision id, return its revno"""
 
3073
        if _mod_revision.is_null(revision_id):
 
3074
            return 0
 
3075
        try:
 
3076
            index = self._partial_revision_history_cache.index(revision_id)
 
3077
        except ValueError:
 
3078
            try:
 
3079
                self._extend_partial_history(stop_revision=revision_id)
 
3080
            except errors.RevisionNotPresent, e:
 
3081
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
3082
            index = len(self._partial_revision_history_cache) - 1
 
3083
            if index < 0:
 
3084
                raise errors.NoSuchRevision(self, revision_id)
 
3085
            if self._partial_revision_history_cache[index] != revision_id:
 
3086
                raise errors.NoSuchRevision(self, revision_id)
 
3087
        return self.revno() - index
 
3088
 
 
3089
 
 
3090
class BzrBranch7(BzrBranch8):
 
3091
    """A branch with support for a fallback repository."""
 
3092
 
 
3093
    def set_reference_info(self, file_id, tree_path, branch_location):
 
3094
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
 
3095
 
 
3096
    def get_reference_info(self, file_id):
 
3097
        Branch.get_reference_info(self, file_id)
 
3098
 
 
3099
    def reference_parent(self, file_id, path, possible_transports=None):
 
3100
        return Branch.reference_parent(self, file_id, path,
 
3101
                                       possible_transports)
 
3102
 
 
3103
 
 
3104
class BzrBranch6(BzrBranch7):
 
3105
    """See BzrBranchFormat6 for the capabilities of this branch.
 
3106
 
 
3107
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
 
3108
    i.e. stacking.
2094
3109
    """
2095
3110
 
2096
 
    def __init__(self, transport_server, transport_readonly_server, formats,
2097
 
        vfs_transport_factory=None):
2098
 
        self._transport_server = transport_server
2099
 
        self._transport_readonly_server = transport_readonly_server
2100
 
        self._formats = formats
2101
 
    
2102
 
    def adapt(self, test):
2103
 
        result = TestSuite()
2104
 
        for branch_format, bzrdir_format in self._formats:
2105
 
            new_test = deepcopy(test)
2106
 
            new_test.transport_server = self._transport_server
2107
 
            new_test.transport_readonly_server = self._transport_readonly_server
2108
 
            new_test.bzrdir_format = bzrdir_format
2109
 
            new_test.branch_format = branch_format
2110
 
            def make_new_test_id():
2111
 
                # the format can be either a class or an instance
2112
 
                name = getattr(branch_format, '__name__',
2113
 
                        branch_format.__class__.__name__)
2114
 
                new_id = "%s(%s)" % (new_test.id(), name)
2115
 
                return lambda: new_id
2116
 
            new_test.id = make_new_test_id()
2117
 
            result.addTest(new_test)
2118
 
        return result
 
3111
    def get_stacked_on_url(self):
 
3112
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2119
3113
 
2120
3114
 
2121
3115
######################################################################
2139
3133
    :ivar new_revno: Revision number after pull.
2140
3134
    :ivar old_revid: Tip revision id before pull.
2141
3135
    :ivar new_revid: Tip revision id after pull.
2142
 
    :ivar source_branch: Source (local) branch object.
2143
 
    :ivar master_branch: Master branch of the target, or None.
2144
 
    :ivar target_branch: Target/destination branch object.
 
3136
    :ivar source_branch: Source (local) branch object. (read locked)
 
3137
    :ivar master_branch: Master branch of the target, or the target if no
 
3138
        Master
 
3139
    :ivar local_branch: target branch if there is a Master, else None
 
3140
    :ivar target_branch: Target/destination branch object. (write locked)
 
3141
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
3142
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2145
3143
    """
2146
3144
 
 
3145
    @deprecated_method(deprecated_in((2, 3, 0)))
2147
3146
    def __int__(self):
2148
 
        # DEPRECATED: pull used to return the change in revno
 
3147
        """Return the relative change in revno.
 
3148
 
 
3149
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3150
        """
2149
3151
        return self.new_revno - self.old_revno
2150
3152
 
2151
3153
    def report(self, to_file):
2152
 
        if self.old_revid == self.new_revid:
2153
 
            to_file.write('No revisions to pull.\n')
2154
 
        else:
2155
 
            to_file.write('Now on revision %d.\n' % self.new_revno)
 
3154
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3155
        tag_updates = getattr(self, "tag_updates", None)
 
3156
        if not is_quiet():
 
3157
            if self.old_revid != self.new_revid:
 
3158
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
3159
            if tag_updates:
 
3160
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
3161
            if self.old_revid == self.new_revid and not tag_updates:
 
3162
                if not tag_conflicts:
 
3163
                    to_file.write('No revisions or tags to pull.\n')
 
3164
                else:
 
3165
                    to_file.write('No revisions to pull.\n')
2156
3166
        self._show_tag_conficts(to_file)
2157
3167
 
2158
3168
 
2159
 
class PushResult(_Result):
 
3169
class BranchPushResult(_Result):
2160
3170
    """Result of a Branch.push operation.
2161
3171
 
2162
 
    :ivar old_revno: Revision number before push.
2163
 
    :ivar new_revno: Revision number after push.
2164
 
    :ivar old_revid: Tip revision id before push.
2165
 
    :ivar new_revid: Tip revision id after push.
2166
 
    :ivar source_branch: Source branch object.
2167
 
    :ivar master_branch: Master branch of the target, or None.
2168
 
    :ivar target_branch: Target/destination branch object.
 
3172
    :ivar old_revno: Revision number (eg 10) of the target before push.
 
3173
    :ivar new_revno: Revision number (eg 12) of the target after push.
 
3174
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
 
3175
        before the push.
 
3176
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
 
3177
        after the push.
 
3178
    :ivar source_branch: Source branch object that the push was from. This is
 
3179
        read locked, and generally is a local (and thus low latency) branch.
 
3180
    :ivar master_branch: If target is a bound branch, the master branch of
 
3181
        target, or target itself. Always write locked.
 
3182
    :ivar target_branch: The direct Branch where data is being sent (write
 
3183
        locked).
 
3184
    :ivar local_branch: If the target is a bound branch this will be the
 
3185
        target, otherwise it will be None.
2169
3186
    """
2170
3187
 
 
3188
    @deprecated_method(deprecated_in((2, 3, 0)))
2171
3189
    def __int__(self):
2172
 
        # DEPRECATED: push used to return the change in revno
 
3190
        """Return the relative change in revno.
 
3191
 
 
3192
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3193
        """
2173
3194
        return self.new_revno - self.old_revno
2174
3195
 
2175
3196
    def report(self, to_file):
2176
 
        """Write a human-readable description of the result."""
2177
 
        if self.old_revid == self.new_revid:
2178
 
            to_file.write('No new revisions to push.\n')
2179
 
        else:
2180
 
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
 
3197
        # TODO: This function gets passed a to_file, but then
 
3198
        # ignores it and calls note() instead. This is also
 
3199
        # inconsistent with PullResult(), which writes to stdout.
 
3200
        # -- JRV20110901, bug #838853
 
3201
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3202
        tag_updates = getattr(self, "tag_updates", None)
 
3203
        if not is_quiet():
 
3204
            if self.old_revid != self.new_revid:
 
3205
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3206
            if tag_updates:
 
3207
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3208
            if self.old_revid == self.new_revid and not tag_updates:
 
3209
                if not tag_conflicts:
 
3210
                    note(gettext('No new revisions or tags to push.'))
 
3211
                else:
 
3212
                    note(gettext('No new revisions to push.'))
2181
3213
        self._show_tag_conficts(to_file)
2182
3214
 
2183
3215
 
2189
3221
 
2190
3222
    def __init__(self, branch):
2191
3223
        self.branch = branch
 
3224
        self.errors = []
2192
3225
 
2193
3226
    def report_results(self, verbose):
2194
3227
        """Report the check results via trace.note.
2195
 
        
 
3228
 
2196
3229
        :param verbose: Requests more detailed display of what was checked,
2197
3230
            if any.
2198
3231
        """
2199
 
        note('checked branch %s format %s',
2200
 
             self.branch.base,
2201
 
             self.branch._format)
 
3232
        note(gettext('checked branch {0} format {1}').format(
 
3233
                                self.branch.user_url, self.branch._format))
 
3234
        for error in self.errors:
 
3235
            note(gettext('found error:%s'), error)
2202
3236
 
2203
3237
 
2204
3238
class Converter5to6(object):
2210
3244
        new_branch = format.open(branch.bzrdir, _found=True)
2211
3245
 
2212
3246
        # Copy source data into target
2213
 
        new_branch.set_last_revision_info(*branch.last_revision_info())
 
3247
        new_branch._write_last_revision_info(*branch.last_revision_info())
2214
3248
        new_branch.set_parent(branch.get_parent())
2215
3249
        new_branch.set_bound_location(branch.get_bound_location())
2216
3250
        new_branch.set_push_location(branch.get_push_location())
2219
3253
        new_branch.tags._set_tag_dict({})
2220
3254
 
2221
3255
        # Copying done; now update target format
2222
 
        new_branch.control_files.put_utf8('format',
2223
 
            format.get_format_string())
 
3256
        new_branch._transport.put_bytes('format',
 
3257
            format.as_string(),
 
3258
            mode=new_branch.bzrdir._get_file_mode())
2224
3259
 
2225
3260
        # Clean up old files
2226
 
        new_branch.control_files._transport.delete('revision-history')
 
3261
        new_branch._transport.delete('revision-history')
2227
3262
        try:
2228
3263
            branch.set_parent(None)
2229
 
        except NoSuchFile:
 
3264
        except errors.NoSuchFile:
2230
3265
            pass
2231
3266
        branch.set_bound_location(None)
 
3267
 
 
3268
 
 
3269
class Converter6to7(object):
 
3270
    """Perform an in-place upgrade of format 6 to format 7"""
 
3271
 
 
3272
    def convert(self, branch):
 
3273
        format = BzrBranchFormat7()
 
3274
        branch._set_config_location('stacked_on_location', '')
 
3275
        # update target format
 
3276
        branch._transport.put_bytes('format', format.as_string())
 
3277
 
 
3278
 
 
3279
class Converter7to8(object):
 
3280
    """Perform an in-place upgrade of format 7 to format 8"""
 
3281
 
 
3282
    def convert(self, branch):
 
3283
        format = BzrBranchFormat8()
 
3284
        branch._transport.put_bytes('references', '')
 
3285
        # update target format
 
3286
        branch._transport.put_bytes('format', format.as_string())
 
3287
 
 
3288
 
 
3289
class InterBranch(InterObject):
 
3290
    """This class represents operations taking place between two branches.
 
3291
 
 
3292
    Its instances have methods like pull() and push() and contain
 
3293
    references to the source and target repositories these operations
 
3294
    can be carried out on.
 
3295
    """
 
3296
 
 
3297
    _optimisers = []
 
3298
    """The available optimised InterBranch types."""
 
3299
 
 
3300
    @classmethod
 
3301
    def _get_branch_formats_to_test(klass):
 
3302
        """Return an iterable of format tuples for testing.
 
3303
        
 
3304
        :return: An iterable of (from_format, to_format) to use when testing
 
3305
            this InterBranch class. Each InterBranch class should define this
 
3306
            method itself.
 
3307
        """
 
3308
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
3309
 
 
3310
    @needs_write_lock
 
3311
    def pull(self, overwrite=False, stop_revision=None,
 
3312
             possible_transports=None, local=False):
 
3313
        """Mirror source into target branch.
 
3314
 
 
3315
        The target branch is considered to be 'local', having low latency.
 
3316
 
 
3317
        :returns: PullResult instance
 
3318
        """
 
3319
        raise NotImplementedError(self.pull)
 
3320
 
 
3321
    @needs_write_lock
 
3322
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3323
             _override_hook_source_branch=None):
 
3324
        """Mirror the source branch into the target branch.
 
3325
 
 
3326
        The source branch is considered to be 'local', having low latency.
 
3327
        """
 
3328
        raise NotImplementedError(self.push)
 
3329
 
 
3330
    @needs_write_lock
 
3331
    def copy_content_into(self, revision_id=None):
 
3332
        """Copy the content of source into target
 
3333
 
 
3334
        revision_id: if not None, the revision history in the new branch will
 
3335
                     be truncated to end with revision_id.
 
3336
        """
 
3337
        raise NotImplementedError(self.copy_content_into)
 
3338
 
 
3339
    @needs_write_lock
 
3340
    def fetch(self, stop_revision=None, limit=None):
 
3341
        """Fetch revisions.
 
3342
 
 
3343
        :param stop_revision: Last revision to fetch
 
3344
        :param limit: Optional rough limit of revisions to fetch
 
3345
        """
 
3346
        raise NotImplementedError(self.fetch)
 
3347
 
 
3348
 
 
3349
class GenericInterBranch(InterBranch):
 
3350
    """InterBranch implementation that uses public Branch functions."""
 
3351
 
 
3352
    @classmethod
 
3353
    def is_compatible(klass, source, target):
 
3354
        # GenericBranch uses the public API, so always compatible
 
3355
        return True
 
3356
 
 
3357
    @classmethod
 
3358
    def _get_branch_formats_to_test(klass):
 
3359
        return [(format_registry.get_default(), format_registry.get_default())]
 
3360
 
 
3361
    @classmethod
 
3362
    def unwrap_format(klass, format):
 
3363
        if isinstance(format, remote.RemoteBranchFormat):
 
3364
            format._ensure_real()
 
3365
            return format._custom_format
 
3366
        return format
 
3367
 
 
3368
    @needs_write_lock
 
3369
    def copy_content_into(self, revision_id=None):
 
3370
        """Copy the content of source into target
 
3371
 
 
3372
        revision_id: if not None, the revision history in the new branch will
 
3373
                     be truncated to end with revision_id.
 
3374
        """
 
3375
        self.source.update_references(self.target)
 
3376
        self.source._synchronize_history(self.target, revision_id)
 
3377
        try:
 
3378
            parent = self.source.get_parent()
 
3379
        except errors.InaccessibleParent, e:
 
3380
            mutter('parent was not accessible to copy: %s', e)
 
3381
        else:
 
3382
            if parent:
 
3383
                self.target.set_parent(parent)
 
3384
        if self.source._push_should_merge_tags():
 
3385
            self.source.tags.merge_to(self.target.tags)
 
3386
 
 
3387
    @needs_write_lock
 
3388
    def fetch(self, stop_revision=None, limit=None):
 
3389
        if self.target.base == self.source.base:
 
3390
            return (0, [])
 
3391
        self.source.lock_read()
 
3392
        try:
 
3393
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3394
            fetch_spec_factory.source_branch = self.source
 
3395
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3396
            fetch_spec_factory.source_repo = self.source.repository
 
3397
            fetch_spec_factory.target_repo = self.target.repository
 
3398
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3399
            fetch_spec_factory.limit = limit
 
3400
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3401
            return self.target.repository.fetch(self.source.repository,
 
3402
                fetch_spec=fetch_spec)
 
3403
        finally:
 
3404
            self.source.unlock()
 
3405
 
 
3406
    @needs_write_lock
 
3407
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3408
            graph=None):
 
3409
        other_revno, other_last_revision = self.source.last_revision_info()
 
3410
        stop_revno = None # unknown
 
3411
        if stop_revision is None:
 
3412
            stop_revision = other_last_revision
 
3413
            if _mod_revision.is_null(stop_revision):
 
3414
                # if there are no commits, we're done.
 
3415
                return
 
3416
            stop_revno = other_revno
 
3417
 
 
3418
        # what's the current last revision, before we fetch [and change it
 
3419
        # possibly]
 
3420
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3421
        # we fetch here so that we don't process data twice in the common
 
3422
        # case of having something to pull, and so that the check for
 
3423
        # already merged can operate on the just fetched graph, which will
 
3424
        # be cached in memory.
 
3425
        self.fetch(stop_revision=stop_revision)
 
3426
        # Check to see if one is an ancestor of the other
 
3427
        if not overwrite:
 
3428
            if graph is None:
 
3429
                graph = self.target.repository.get_graph()
 
3430
            if self.target._check_if_descendant_or_diverged(
 
3431
                    stop_revision, last_rev, graph, self.source):
 
3432
                # stop_revision is a descendant of last_rev, but we aren't
 
3433
                # overwriting, so we're done.
 
3434
                return
 
3435
        if stop_revno is None:
 
3436
            if graph is None:
 
3437
                graph = self.target.repository.get_graph()
 
3438
            this_revno, this_last_revision = \
 
3439
                    self.target.last_revision_info()
 
3440
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3441
                            [(other_last_revision, other_revno),
 
3442
                             (this_last_revision, this_revno)])
 
3443
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3444
 
 
3445
    @needs_write_lock
 
3446
    def pull(self, overwrite=False, stop_revision=None,
 
3447
             possible_transports=None, run_hooks=True,
 
3448
             _override_hook_target=None, local=False):
 
3449
        """Pull from source into self, updating my master if any.
 
3450
 
 
3451
        :param run_hooks: Private parameter - if false, this branch
 
3452
            is being called because it's the master of the primary branch,
 
3453
            so it should not run its hooks.
 
3454
        """
 
3455
        bound_location = self.target.get_bound_location()
 
3456
        if local and not bound_location:
 
3457
            raise errors.LocalRequiresBoundBranch()
 
3458
        master_branch = None
 
3459
        source_is_master = False
 
3460
        if bound_location:
 
3461
            # bound_location comes from a config file, some care has to be
 
3462
            # taken to relate it to source.user_url
 
3463
            normalized = urlutils.normalize_url(bound_location)
 
3464
            try:
 
3465
                relpath = self.source.user_transport.relpath(normalized)
 
3466
                source_is_master = (relpath == '')
 
3467
            except (errors.PathNotChild, errors.InvalidURL):
 
3468
                source_is_master = False
 
3469
        if not local and bound_location and not source_is_master:
 
3470
            # not pulling from master, so we need to update master.
 
3471
            master_branch = self.target.get_master_branch(possible_transports)
 
3472
            master_branch.lock_write()
 
3473
        try:
 
3474
            if master_branch:
 
3475
                # pull from source into master.
 
3476
                master_branch.pull(self.source, overwrite, stop_revision,
 
3477
                    run_hooks=False)
 
3478
            return self._pull(overwrite,
 
3479
                stop_revision, _hook_master=master_branch,
 
3480
                run_hooks=run_hooks,
 
3481
                _override_hook_target=_override_hook_target,
 
3482
                merge_tags_to_master=not source_is_master)
 
3483
        finally:
 
3484
            if master_branch:
 
3485
                master_branch.unlock()
 
3486
 
 
3487
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3488
             _override_hook_source_branch=None):
 
3489
        """See InterBranch.push.
 
3490
 
 
3491
        This is the basic concrete implementation of push()
 
3492
 
 
3493
        :param _override_hook_source_branch: If specified, run the hooks
 
3494
            passing this Branch as the source, rather than self.  This is for
 
3495
            use of RemoteBranch, where push is delegated to the underlying
 
3496
            vfs-based Branch.
 
3497
        """
 
3498
        if lossy:
 
3499
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3500
        # TODO: Public option to disable running hooks - should be trivial but
 
3501
        # needs tests.
 
3502
 
 
3503
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3504
        op.add_cleanup(self.source.lock_read().unlock)
 
3505
        op.add_cleanup(self.target.lock_write().unlock)
 
3506
        return op.run(overwrite, stop_revision,
 
3507
            _override_hook_source_branch=_override_hook_source_branch)
 
3508
 
 
3509
    def _basic_push(self, overwrite, stop_revision):
 
3510
        """Basic implementation of push without bound branches or hooks.
 
3511
 
 
3512
        Must be called with source read locked and target write locked.
 
3513
        """
 
3514
        result = BranchPushResult()
 
3515
        result.source_branch = self.source
 
3516
        result.target_branch = self.target
 
3517
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3518
        self.source.update_references(self.target)
 
3519
        if result.old_revid != stop_revision:
 
3520
            # We assume that during 'push' this repository is closer than
 
3521
            # the target.
 
3522
            graph = self.source.repository.get_graph(self.target.repository)
 
3523
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3524
                    graph=graph)
 
3525
        if self.source._push_should_merge_tags():
 
3526
            result.tag_updates, result.tag_conflicts = (
 
3527
                self.source.tags.merge_to(self.target.tags, overwrite))
 
3528
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3529
        return result
 
3530
 
 
3531
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3532
            _override_hook_source_branch=None):
 
3533
        """Push from source into target, and into target's master if any.
 
3534
        """
 
3535
        def _run_hooks():
 
3536
            if _override_hook_source_branch:
 
3537
                result.source_branch = _override_hook_source_branch
 
3538
            for hook in Branch.hooks['post_push']:
 
3539
                hook(result)
 
3540
 
 
3541
        bound_location = self.target.get_bound_location()
 
3542
        if bound_location and self.target.base != bound_location:
 
3543
            # there is a master branch.
 
3544
            #
 
3545
            # XXX: Why the second check?  Is it even supported for a branch to
 
3546
            # be bound to itself? -- mbp 20070507
 
3547
            master_branch = self.target.get_master_branch()
 
3548
            master_branch.lock_write()
 
3549
            operation.add_cleanup(master_branch.unlock)
 
3550
            # push into the master from the source branch.
 
3551
            master_inter = InterBranch.get(self.source, master_branch)
 
3552
            master_inter._basic_push(overwrite, stop_revision)
 
3553
            # and push into the target branch from the source. Note that
 
3554
            # we push from the source branch again, because it's considered
 
3555
            # the highest bandwidth repository.
 
3556
            result = self._basic_push(overwrite, stop_revision)
 
3557
            result.master_branch = master_branch
 
3558
            result.local_branch = self.target
 
3559
        else:
 
3560
            master_branch = None
 
3561
            # no master branch
 
3562
            result = self._basic_push(overwrite, stop_revision)
 
3563
            # TODO: Why set master_branch and local_branch if there's no
 
3564
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3565
            # 20070504
 
3566
            result.master_branch = self.target
 
3567
            result.local_branch = None
 
3568
        _run_hooks()
 
3569
        return result
 
3570
 
 
3571
    def _pull(self, overwrite=False, stop_revision=None,
 
3572
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3573
             _override_hook_target=None, local=False,
 
3574
             merge_tags_to_master=True):
 
3575
        """See Branch.pull.
 
3576
 
 
3577
        This function is the core worker, used by GenericInterBranch.pull to
 
3578
        avoid duplication when pulling source->master and source->local.
 
3579
 
 
3580
        :param _hook_master: Private parameter - set the branch to
 
3581
            be supplied as the master to pull hooks.
 
3582
        :param run_hooks: Private parameter - if false, this branch
 
3583
            is being called because it's the master of the primary branch,
 
3584
            so it should not run its hooks.
 
3585
            is being called because it's the master of the primary branch,
 
3586
            so it should not run its hooks.
 
3587
        :param _override_hook_target: Private parameter - set the branch to be
 
3588
            supplied as the target_branch to pull hooks.
 
3589
        :param local: Only update the local branch, and not the bound branch.
 
3590
        """
 
3591
        # This type of branch can't be bound.
 
3592
        if local:
 
3593
            raise errors.LocalRequiresBoundBranch()
 
3594
        result = PullResult()
 
3595
        result.source_branch = self.source
 
3596
        if _override_hook_target is None:
 
3597
            result.target_branch = self.target
 
3598
        else:
 
3599
            result.target_branch = _override_hook_target
 
3600
        self.source.lock_read()
 
3601
        try:
 
3602
            # We assume that during 'pull' the target repository is closer than
 
3603
            # the source one.
 
3604
            self.source.update_references(self.target)
 
3605
            graph = self.target.repository.get_graph(self.source.repository)
 
3606
            # TODO: Branch formats should have a flag that indicates 
 
3607
            # that revno's are expensive, and pull() should honor that flag.
 
3608
            # -- JRV20090506
 
3609
            result.old_revno, result.old_revid = \
 
3610
                self.target.last_revision_info()
 
3611
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3612
                graph=graph)
 
3613
            # TODO: The old revid should be specified when merging tags, 
 
3614
            # so a tags implementation that versions tags can only 
 
3615
            # pull in the most recent changes. -- JRV20090506
 
3616
            result.tag_updates, result.tag_conflicts = (
 
3617
                self.source.tags.merge_to(self.target.tags, overwrite,
 
3618
                    ignore_master=not merge_tags_to_master))
 
3619
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3620
            if _hook_master:
 
3621
                result.master_branch = _hook_master
 
3622
                result.local_branch = result.target_branch
 
3623
            else:
 
3624
                result.master_branch = result.target_branch
 
3625
                result.local_branch = None
 
3626
            if run_hooks:
 
3627
                for hook in Branch.hooks['post_pull']:
 
3628
                    hook(result)
 
3629
        finally:
 
3630
            self.source.unlock()
 
3631
        return result
 
3632
 
 
3633
 
 
3634
InterBranch.register_optimiser(GenericInterBranch)