/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2018-05-19 13:16:11 UTC
  • mto: (6968.4.3 git-archive)
  • mto: This revision was merged to the branch mainline in revision 6972.
  • Revision ID: jelmer@jelmer.uk-20180519131611-l9h9ud41j7qg1m03
Move tar/zip to breezy.archive.

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