/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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