~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-15 11:06:07 UTC
  • mfrom: (6504.1.2 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20120315110607-bbulg6wegrhwnavm
(vila) Release 2.6b1 (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

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