/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 breezy/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2020-03-22 21:29:51 UTC
  • mto: (7490.7.7 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200322212951-6nu7tdaq5cff3qg4
Fix git tests.

Show diffs side-by-side

added added

removed removed

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