/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

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