/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2019-06-03 21:45:21 UTC
  • mto: This revision was merged to the branch mainline in revision 7315.
  • Revision ID: jelmer@jelmer.uk-20190603214521-34fa5tp86ncfnn4h
Fix test; .git is now properly recognized as a control dir name.

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