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