/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2018-11-24 15:56:05 UTC
  • mto: This revision was merged to the branch mainline in revision 7214.
  • Revision ID: jelmer@jelmer.uk-20181124155605-g8yh28kpruubzgjk
Remove references to bzrtools.

Show diffs side-by-side

added added

removed removed

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