/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
 
        symbol_versioning,
36
33
        transport,
37
34
        tsort,
38
35
        ui,
39
36
        urlutils,
40
37
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
 
38
from bzrlib.config import BranchConfig
42
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
40
from bzrlib.tag import (
44
41
    BasicTags,
46
43
    )
47
44
""")
48
45
 
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
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
54
48
from bzrlib.symbol_versioning import (
55
49
    deprecated_in,
56
50
    deprecated_method,
63
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
58
 
65
59
 
66
 
class Branch(bzrdir.ControlComponent):
 
60
# TODO: Maybe include checks for common corruption of newlines, etc?
 
61
 
 
62
# TODO: Some operations like log might retrieve the same revisions
 
63
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
64
# cache in memory to make this faster.  In general anything can be
 
65
# cached in memory between lock and unlock operations. .. nb thats
 
66
# what the transaction identity map provides
 
67
 
 
68
 
 
69
######################################################################
 
70
# branch objects
 
71
 
 
72
class Branch(object):
67
73
    """Branch holding a history of revisions.
68
74
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
75
    base
 
76
        Base directory/url of the branch.
72
77
 
73
78
    hooks: An instance of BranchHooks.
74
79
    """
76
81
    # - RBC 20060112
77
82
    base = None
78
83
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
 
84
    # override this to set the strategy for storing tags
 
85
    def _make_tags(self):
 
86
        return DisabledTags(self)
86
87
 
87
88
    def __init__(self, *ignored, **ignored_too):
88
 
        self.tags = self._format.make_tags(self)
 
89
        self.tags = self._make_tags()
89
90
        self._revision_history_cache = None
90
91
        self._revision_id_to_revno_cache = None
91
92
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
93
        self._last_revision_info_cache = None
94
94
        self._merge_sorted_revisions_cache = None
95
95
        self._open_hook()
100
100
    def _open_hook(self):
101
101
        """Called by init to allow simpler extension of the base class."""
102
102
 
103
 
    def _activate_fallback_location(self, url):
104
 
        """Activate the branch/repository from url as a fallback repository."""
105
 
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
108
 
        self.repository.add_fallback_repository(repo)
109
 
 
110
103
    def break_lock(self):
111
104
        """Break a lock if one is present from another instance.
112
105
 
121
114
        if master is not None:
122
115
            master.break_lock()
123
116
 
124
 
    def _check_stackable_repo(self):
125
 
        if not self.repository._format.supports_external_lookups:
126
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
 
                self.repository.base)
128
 
 
129
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
 
        """Extend the partial history to include a given index
131
 
 
132
 
        If a stop_index is supplied, stop when that index has been reached.
133
 
        If a stop_revision is supplied, stop when that revision is
134
 
        encountered.  Otherwise, stop when the beginning of history is
135
 
        reached.
136
 
 
137
 
        :param stop_index: The index which should be present.  When it is
138
 
            present, history extension will stop.
139
 
        :param stop_revision: The revision id which should be present.  When
140
 
            it is encountered, history extension will stop.
141
 
        """
142
 
        if len(self._partial_revision_history_cache) == 0:
143
 
            self._partial_revision_history_cache = [self.last_revision()]
144
 
        repository._iter_for_revno(
145
 
            self.repository, self._partial_revision_history_cache,
146
 
            stop_index=stop_index, stop_revision=stop_revision)
147
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
 
            self._partial_revision_history_cache.pop()
149
 
 
150
 
    def _get_check_refs(self):
151
 
        """Get the references needed for check().
152
 
 
153
 
        See bzrlib.check.
154
 
        """
155
 
        revid = self.last_revision()
156
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
157
 
 
158
117
    @staticmethod
159
118
    def open(base, _unsupported=False, possible_transports=None):
160
119
        """Open the branch rooted at base.
164
123
        """
165
124
        control = bzrdir.BzrDir.open(base, _unsupported,
166
125
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
126
        return control.open_branch(_unsupported)
168
127
 
169
128
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
129
    def open_from_transport(transport, _unsupported=False):
171
130
        """Open the branch rooted at transport"""
172
131
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
132
        return control.open_branch(_unsupported)
174
133
 
175
134
    @staticmethod
176
135
    def open_containing(url, possible_transports=None):
177
136
        """Open an existing branch which contains url.
178
 
 
 
137
        
179
138
        This probes for a branch at url, and searches upwards from there.
180
139
 
181
140
        Basically we keep looking up until we find the control directory or
182
141
        run into the root.  If there isn't one, raises NotBranchError.
183
 
        If there is one and it is either an unrecognised format or an unsupported
 
142
        If there is one and it is either an unrecognised format or an unsupported 
184
143
        format, UnknownFormatError or UnsupportedFormatError are raised.
185
144
        If there is one, it is returned, along with the unused portion of url.
186
145
        """
188
147
                                                         possible_transports)
189
148
        return control.open_branch(), relpath
190
149
 
191
 
    def _push_should_merge_tags(self):
192
 
        """Should _basic_push merge this branch's tags into the target?
193
 
 
194
 
        The default implementation returns False if this branch has no tags,
195
 
        and True the rest of the time.  Subclasses may override this.
196
 
        """
197
 
        return self.supports_tags() and self.tags.get_tag_dict()
198
 
 
199
150
    def get_config(self):
200
151
        return BranchConfig(self)
201
152
 
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):
215
 
        """Get the repository we fallback to at url."""
216
 
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
218
 
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
220
 
 
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
153
    def _get_nick(self, local=False, possible_transports=None):
236
154
        config = self.get_config()
237
155
        # explicit overrides master, but don't look for master if local is True
256
174
    def is_locked(self):
257
175
        raise NotImplementedError(self.is_locked)
258
176
 
259
 
    def _lefthand_history(self, revision_id, last_rev=None,
260
 
                          other_branch=None):
261
 
        if 'evil' in debug.debug_flags:
262
 
            mutter_callsite(4, "_lefthand_history scales with history.")
263
 
        # stop_revision must be a descendant of last_revision
264
 
        graph = self.repository.get_graph()
265
 
        if last_rev is not None:
266
 
            if not graph.is_ancestor(last_rev, revision_id):
267
 
                # our previous tip is not merged into stop_revision
268
 
                raise errors.DivergedBranches(self, other_branch)
269
 
        # make a new revision history from the graph
270
 
        parents_map = graph.get_parent_map([revision_id])
271
 
        if revision_id not in parents_map:
272
 
            raise errors.NoSuchRevision(self, revision_id)
273
 
        current_rev_id = revision_id
274
 
        new_history = []
275
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
276
 
        # Do not include ghosts or graph origin in revision_history
277
 
        while (current_rev_id in parents_map and
278
 
               len(parents_map[current_rev_id]) > 0):
279
 
            check_not_reserved_id(current_rev_id)
280
 
            new_history.append(current_rev_id)
281
 
            current_rev_id = parents_map[current_rev_id][0]
282
 
            parents_map = graph.get_parent_map([current_rev_id])
283
 
        new_history.reverse()
284
 
        return new_history
285
 
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
177
    def lock_write(self):
293
178
        raise NotImplementedError(self.lock_write)
294
179
 
295
180
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
181
        raise NotImplementedError(self.lock_read)
301
182
 
302
183
    def unlock(self):
347
228
    @needs_read_lock
348
229
    def revision_id_to_dotted_revno(self, revision_id):
349
230
        """Given a revision id, return its dotted revno.
350
 
 
 
231
        
351
232
        :return: a tuple like (1,) or (400,1,3).
352
233
        """
353
234
        return self._do_revision_id_to_dotted_revno(revision_id)
427
308
            * 'include' - the stop revision is the last item in the result
428
309
            * 'with-merges' - include the stop revision and all of its
429
310
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
311
        :param direction: either 'reverse' or 'forward':
433
312
            * reverse means return the start_revision_id first, i.e.
434
313
              start at the most recent revision and go backwards in history
456
335
        # start_revision_id.
457
336
        if self._merge_sorted_revisions_cache is None:
458
337
            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)
 
338
            graph = self.repository.get_graph()
 
339
            parent_map = dict(((key, value) for key, value in
 
340
                     graph.iter_ancestry([last_revision]) if value is not None))
 
341
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
342
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
343
                generate_revno=True)
 
344
            # Drop the sequence # before caching
 
345
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
346
 
463
347
        filtered = self._filter_merge_sorted_revisions(
464
348
            self._merge_sorted_revisions_cache, start_revision_id,
465
349
            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
350
        if direction == 'reverse':
470
351
            return filtered
471
352
        if direction == 'forward':
478
359
        """Iterate over an inclusive range of sorted revisions."""
479
360
        rev_iter = iter(merge_sorted_revisions)
480
361
        if start_revision_id is not None:
481
 
            for node in rev_iter:
482
 
                rev_id = node.key[-1]
 
362
            for rev_id, depth, revno, end_of_merge in rev_iter:
483
363
                if rev_id != start_revision_id:
484
364
                    continue
485
365
                else:
486
366
                    # The decision to include the start or not
487
367
                    # depends on the stop_rule if a stop is provided
488
 
                    # so pop this node back into the iterator
489
 
                    rev_iter = chain(iter([node]), rev_iter)
 
368
                    rev_iter = chain(
 
369
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
370
                        rev_iter)
490
371
                    break
491
372
        if stop_revision_id is None:
492
 
            # Yield everything
493
 
            for node in rev_iter:
494
 
                rev_id = node.key[-1]
495
 
                yield (rev_id, node.merge_depth, node.revno,
496
 
                       node.end_of_merge)
 
373
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
374
                yield rev_id, depth, revno, end_of_merge
497
375
        elif stop_rule == 'exclude':
498
 
            for node in rev_iter:
499
 
                rev_id = node.key[-1]
 
376
            for rev_id, depth, revno, end_of_merge in rev_iter:
500
377
                if rev_id == stop_revision_id:
501
378
                    return
502
 
                yield (rev_id, node.merge_depth, node.revno,
503
 
                       node.end_of_merge)
 
379
                yield rev_id, depth, revno, end_of_merge
504
380
        elif stop_rule == 'include':
505
 
            for node in rev_iter:
506
 
                rev_id = node.key[-1]
507
 
                yield (rev_id, node.merge_depth, node.revno,
508
 
                       node.end_of_merge)
 
381
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
382
                yield rev_id, depth, revno, end_of_merge
509
383
                if rev_id == stop_revision_id:
510
384
                    return
511
 
        elif stop_rule == 'with-merges-without-common-ancestry':
512
 
            # We want to exclude all revisions that are already part of the
513
 
            # stop_revision_id ancestry.
514
 
            graph = self.repository.get_graph()
515
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
516
 
                                                    [stop_revision_id])
517
 
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
519
 
                if rev_id not in ancestors:
520
 
                    continue
521
 
                yield (rev_id, node.merge_depth, node.revno,
522
 
                       node.end_of_merge)
523
385
        elif stop_rule == 'with-merges':
524
386
            stop_rev = self.repository.get_revision(stop_revision_id)
525
387
            if stop_rev.parent_ids:
526
388
                left_parent = stop_rev.parent_ids[0]
527
389
            else:
528
390
                left_parent = _mod_revision.NULL_REVISION
529
 
            # left_parent is the actual revision we want to stop logging at,
530
 
            # since we want to show the merged revisions after the stop_rev too
531
 
            reached_stop_revision_id = False
532
 
            revision_id_whitelist = []
533
 
            for node in rev_iter:
534
 
                rev_id = node.key[-1]
 
391
            for rev_id, depth, revno, end_of_merge in rev_iter:
535
392
                if rev_id == left_parent:
536
 
                    # reached the left parent after the stop_revision
537
393
                    return
538
 
                if (not reached_stop_revision_id or
539
 
                        rev_id in revision_id_whitelist):
540
 
                    yield (rev_id, node.merge_depth, node.revno,
541
 
                       node.end_of_merge)
542
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
543
 
                        # only do the merged revs of rev_id from now on
544
 
                        rev = self.repository.get_revision(rev_id)
545
 
                        if rev.parent_ids:
546
 
                            reached_stop_revision_id = True
547
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
394
                yield rev_id, depth, revno, end_of_merge
548
395
        else:
549
396
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
397
 
551
 
    def _filter_start_non_ancestors(self, rev_iter):
552
 
        # If we started from a dotted revno, we want to consider it as a tip
553
 
        # and don't want to yield revisions that are not part of its
554
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
555
 
        # uninteresting descendants of the first parent of our tip before the
556
 
        # tip itself.
557
 
        first = rev_iter.next()
558
 
        (rev_id, merge_depth, revno, end_of_merge) = first
559
 
        yield first
560
 
        if not merge_depth:
561
 
            # We start at a mainline revision so by definition, all others
562
 
            # revisions in rev_iter are ancestors
563
 
            for node in rev_iter:
564
 
                yield node
565
 
 
566
 
        clean = False
567
 
        whitelist = set()
568
 
        pmap = self.repository.get_parent_map([rev_id])
569
 
        parents = pmap.get(rev_id, [])
570
 
        if parents:
571
 
            whitelist.update(parents)
572
 
        else:
573
 
            # If there is no parents, there is nothing of interest left
574
 
 
575
 
            # FIXME: It's hard to test this scenario here as this code is never
576
 
            # called in that case. -- vila 20100322
577
 
            return
578
 
 
579
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
580
 
            if not clean:
581
 
                if rev_id in whitelist:
582
 
                    pmap = self.repository.get_parent_map([rev_id])
583
 
                    parents = pmap.get(rev_id, [])
584
 
                    whitelist.remove(rev_id)
585
 
                    whitelist.update(parents)
586
 
                    if merge_depth == 0:
587
 
                        # We've reached the mainline, there is nothing left to
588
 
                        # filter
589
 
                        clean = True
590
 
                else:
591
 
                    # A revision that is not part of the ancestry of our
592
 
                    # starting revision.
593
 
                    continue
594
 
            yield (rev_id, merge_depth, revno, end_of_merge)
595
 
 
596
398
    def leave_lock_in_place(self):
597
399
        """Tell this branch object not to release the physical lock when this
598
400
        object is unlocked.
599
 
 
 
401
        
600
402
        If lock_write doesn't return a token, then this method is not supported.
601
403
        """
602
404
        self.control_files.leave_in_place()
615
417
        :param other: The branch to bind to
616
418
        :type other: Branch
617
419
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
619
 
 
620
 
    def set_append_revisions_only(self, enabled):
621
 
        if not self._format.supports_set_append_revisions_only():
622
 
            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)
629
 
 
630
 
    def set_reference_info(self, file_id, tree_path, branch_location):
631
 
        """Set the branch location to use for a tree reference."""
632
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
633
 
 
634
 
    def get_reference_info(self, file_id):
635
 
        """Get the tree_path and branch_location for a tree reference."""
636
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
420
        raise errors.UpgradeRequired(self.base)
637
421
 
638
422
    @needs_write_lock
639
423
    def fetch(self, from_branch, last_revision=None, pb=None):
643
427
        :param last_revision: What revision to stop at (None for at the end
644
428
                              of the branch.
645
429
        :param pb: An optional progress bar to use.
646
 
        :return: None
 
430
 
 
431
        Returns the copied revision count and the failed revisions in a tuple:
 
432
        (copied, failures).
647
433
        """
648
434
        if self.base == from_branch.base:
649
435
            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()")
 
436
        if pb is None:
 
437
            nested_pb = ui.ui_factory.nested_progress_bar()
 
438
            pb = nested_pb
 
439
        else:
 
440
            nested_pb = None
 
441
 
654
442
        from_branch.lock_read()
655
443
        try:
656
444
            if last_revision is None:
 
445
                pb.update('get source history')
657
446
                last_revision = from_branch.last_revision()
658
447
                last_revision = _mod_revision.ensure_null(last_revision)
659
448
            return self.repository.fetch(from_branch.repository,
660
449
                                         revision_id=last_revision,
661
 
                                         pb=pb)
 
450
                                         pb=nested_pb)
662
451
        finally:
 
452
            if nested_pb is not None:
 
453
                nested_pb.finished()
663
454
            from_branch.unlock()
664
455
 
665
456
    def get_bound_location(self):
669
460
        branch.
670
461
        """
671
462
        return None
672
 
 
 
463
    
673
464
    def get_old_bound_location(self):
674
465
        """Return the URL of the branch we used to be bound to
675
466
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
467
        raise errors.UpgradeRequired(self.base)
677
468
 
678
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
 
                           timezone=None, committer=None, revprops=None,
 
469
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
470
                           timezone=None, committer=None, revprops=None, 
680
471
                           revision_id=None):
681
472
        """Obtain a CommitBuilder for this branch.
682
 
 
 
473
        
683
474
        :param parents: Revision ids of the parents of the new revision.
684
475
        :param config: Optional configuration to use.
685
476
        :param timestamp: Optional timestamp recorded for commit.
691
482
 
692
483
        if config is None:
693
484
            config = self.get_config()
694
 
 
 
485
        
695
486
        return self.repository.get_commit_builder(self, parents, config,
696
487
            timestamp, timezone, committer, revprops, revision_id)
697
488
 
698
489
    def get_master_branch(self, possible_transports=None):
699
490
        """Return the branch we are bound to.
700
 
 
 
491
        
701
492
        :return: Either a Branch, or None
702
493
        """
703
494
        return None
729
520
    def set_revision_history(self, rev_history):
730
521
        raise NotImplementedError(self.set_revision_history)
731
522
 
732
 
    @needs_write_lock
733
 
    def set_parent(self, url):
734
 
        """See Branch.set_parent."""
735
 
        # TODO: Maybe delete old location files?
736
 
        # URLs should never be unicode, even on the local fs,
737
 
        # FIXUP this and get_parent in a future branch format bump:
738
 
        # read and rewrite the file. RBC 20060125
739
 
        if url is not None:
740
 
            if isinstance(url, unicode):
741
 
                try:
742
 
                    url = url.encode('ascii')
743
 
                except UnicodeEncodeError:
744
 
                    raise errors.InvalidURL(url,
745
 
                        "Urls must be 7-bit ascii, "
746
 
                        "use bzrlib.urlutils.escape")
747
 
            url = urlutils.relative_url(self.base, url)
748
 
        self._set_parent_location(url)
749
 
 
750
 
    @needs_write_lock
751
523
    def set_stacked_on_url(self, url):
752
524
        """Set the URL this branch is stacked against.
753
525
 
756
528
        :raises UnstackableRepositoryFormat: If the repository does not support
757
529
            stacking.
758
530
        """
759
 
        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)
777
 
 
778
 
    def _unstack(self):
779
 
        """Change a branch to be unstacked, copying data as needed.
780
 
        
781
 
        Don't call this directly, use set_stacked_on_url(None).
782
 
        """
783
 
        pb = ui.ui_factory.nested_progress_bar()
784
 
        try:
785
 
            pb.update("Unstacking")
786
 
            # The basic approach here is to fetch the tip of the branch,
787
 
            # including all available ghosts, from the existing stacked
788
 
            # repository into a new repository object without the fallbacks. 
789
 
            #
790
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
 
            # correct for CHKMap repostiories
792
 
            old_repository = self.repository
793
 
            if len(old_repository._fallback_repositories) != 1:
794
 
                raise AssertionError("can't cope with fallback repositories "
795
 
                    "of %r" % (self.repository,))
796
 
            # unlock it, including unlocking the fallback
797
 
            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
817
 
                self.repository.lock_write()
818
 
                # XXX: If you unstack a branch while it has a working tree
819
 
                # with a pending merge, the pending-merged revisions will no
820
 
                # 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)
 
531
        raise NotImplementedError(self.set_stacked_on_url)
840
532
 
841
533
    def _cache_revision_history(self, rev_history):
842
534
        """Set the cached revision history to rev_history.
870
562
        self._revision_id_to_revno_cache = None
871
563
        self._last_revision_info_cache = None
872
564
        self._merge_sorted_revisions_cache = None
873
 
        self._partial_revision_history_cache = []
874
 
        self._partial_revision_id_to_revno_cache = {}
875
565
 
876
566
    def _gen_revision_history(self):
877
567
        """Return sequence of revision hashes on to this branch.
878
 
 
 
568
        
879
569
        Unlike revision_history, this method always regenerates or rereads the
880
570
        revision history, i.e. it does not cache the result, so repeated calls
881
571
        may be expensive.
882
572
 
883
573
        Concrete subclasses should override this instead of revision_history so
884
574
        that subclasses do not need to deal with caching logic.
885
 
 
 
575
        
886
576
        This API is semi-public; it only for use by subclasses, all other code
887
577
        should consider it to be private.
888
578
        """
891
581
    @needs_read_lock
892
582
    def revision_history(self):
893
583
        """Return sequence of revision ids on this branch.
894
 
 
 
584
        
895
585
        This method will cache the revision history for as long as it is safe to
896
586
        do so.
897
587
        """
914
604
 
915
605
    def unbind(self):
916
606
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
607
        raise errors.UpgradeRequired(self.base)
 
608
 
 
609
    def set_append_revisions_only(self, enabled):
 
610
        """Older format branches are never restricted to append-only"""
 
611
        raise errors.UpgradeRequired(self.base)
918
612
 
919
613
    def last_revision(self):
920
614
        """Return last revision id, or NULL_REVISION."""
941
635
    @deprecated_method(deprecated_in((1, 6, 0)))
942
636
    def missing_revisions(self, other, stop_revision=None):
943
637
        """Return a list of new revisions that would perfectly fit.
944
 
 
 
638
        
945
639
        If self and other have not diverged, return a list of the revisions
946
640
        present in other, but missing from self.
947
641
        """
974
668
            information. This can be None.
975
669
        :return: None
976
670
        """
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):
981
 
        """Set the last revision info, importing from another repo if necessary.
982
 
 
983
 
        This is used by the bound branch code to upload a revision to
984
 
        the master branch first before updating the tip of the local branch.
985
 
 
986
 
        :param source_repo: Source repository to optionally fetch from
987
 
        :param revno: Revision number of the new tip
988
 
        :param revid: Revision id of the new tip
989
 
        """
990
 
        if not self.repository.has_same_location(source_repo):
991
 
            self.repository.fetch(source_repo, revision_id=revid)
992
 
        self.set_last_revision_info(revno, revid)
 
671
        other.lock_read()
 
672
        try:
 
673
            other_revno, other_last_revision = other.last_revision_info()
 
674
            stop_revno = None # unknown
 
675
            if stop_revision is None:
 
676
                stop_revision = other_last_revision
 
677
                if _mod_revision.is_null(stop_revision):
 
678
                    # if there are no commits, we're done.
 
679
                    return
 
680
                stop_revno = other_revno
 
681
 
 
682
            # what's the current last revision, before we fetch [and change it
 
683
            # possibly]
 
684
            last_rev = _mod_revision.ensure_null(self.last_revision())
 
685
            # we fetch here so that we don't process data twice in the common
 
686
            # case of having something to pull, and so that the check for 
 
687
            # already merged can operate on the just fetched graph, which will
 
688
            # be cached in memory.
 
689
            self.fetch(other, stop_revision)
 
690
            # Check to see if one is an ancestor of the other
 
691
            if not overwrite:
 
692
                if graph is None:
 
693
                    graph = self.repository.get_graph()
 
694
                if self._check_if_descendant_or_diverged(
 
695
                        stop_revision, last_rev, graph, other):
 
696
                    # stop_revision is a descendant of last_rev, but we aren't
 
697
                    # overwriting, so we're done.
 
698
                    return
 
699
            if stop_revno is None:
 
700
                if graph is None:
 
701
                    graph = self.repository.get_graph()
 
702
                this_revno, this_last_revision = self.last_revision_info()
 
703
                stop_revno = graph.find_distance_to_null(stop_revision,
 
704
                                [(other_last_revision, other_revno),
 
705
                                 (this_last_revision, this_revno)])
 
706
            self.set_last_revision_info(stop_revno, stop_revision)
 
707
        finally:
 
708
            other.unlock()
993
709
 
994
710
    def revision_id_to_revno(self, revision_id):
995
711
        """Given a revision id, return its revno"""
1001
717
        except ValueError:
1002
718
            raise errors.NoSuchRevision(self, revision_id)
1003
719
 
1004
 
    @needs_read_lock
1005
720
    def get_rev_id(self, revno, history=None):
1006
721
        """Find the revision id of the specified revno."""
1007
722
        if revno == 0:
1008
723
            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:
 
724
        if history is None:
 
725
            history = self.revision_history()
 
726
        if revno <= 0 or revno > len(history):
1013
727
            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]
 
728
        return history[revno - 1]
1018
729
 
1019
 
    @needs_write_lock
1020
730
    def pull(self, source, overwrite=False, stop_revision=None,
1021
 
             possible_transports=None, *args, **kwargs):
 
731
             possible_transports=None, _override_hook_target=None):
1022
732
        """Mirror source into this branch.
1023
733
 
1024
734
        This branch is considered to be 'local', having low latency.
1025
735
 
1026
736
        :returns: PullResult instance
1027
737
        """
1028
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
 
            stop_revision=stop_revision,
1030
 
            possible_transports=possible_transports, *args, **kwargs)
 
738
        raise NotImplementedError(self.pull)
1031
739
 
1032
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1033
 
        **kwargs):
 
740
    def push(self, target, overwrite=False, stop_revision=None):
1034
741
        """Mirror this branch into target.
1035
742
 
1036
743
        This branch is considered to be 'local', having low latency.
1037
744
        """
1038
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1039
 
            *args, **kwargs)
1040
 
 
1041
 
    def lossy_push(self, target, stop_revision=None):
1042
 
        """Push deltas into another branch.
1043
 
 
1044
 
        :note: This does not, like push, retain the revision ids from 
1045
 
            the source branch and will, rather than adding bzr-specific 
1046
 
            metadata, push only those semantics of the revision that can be 
1047
 
            natively represented by this branch' VCS.
1048
 
 
1049
 
        :param target: Target branch
1050
 
        :param stop_revision: Revision to push, defaults to last revision.
1051
 
        :return: BranchPushResult with an extra member revidmap: 
1052
 
            A dictionary mapping revision ids from the target branch 
1053
 
            to new revision ids in the target branch, for each 
1054
 
            revision that was pushed.
1055
 
        """
1056
 
        inter = InterBranch.get(self, target)
1057
 
        lossy_push = getattr(inter, "lossy_push", None)
1058
 
        if lossy_push is None:
1059
 
            raise errors.LossyPushToSameVCS(self, target)
1060
 
        return lossy_push(stop_revision)
 
745
        raise NotImplementedError(self.push)
1061
746
 
1062
747
    def basis_tree(self):
1063
748
        """Return `Tree` object for last revision."""
1066
751
    def get_parent(self):
1067
752
        """Return the parent location of the branch.
1068
753
 
1069
 
        This is the default location for pull/missing.  The usual
 
754
        This is the default location for push/pull/missing.  The usual
1070
755
        pattern is that the user can override it by specifying a
1071
756
        location.
1072
757
        """
1073
 
        parent = self._get_parent_location()
1074
 
        if parent is None:
1075
 
            return parent
1076
 
        # This is an old-format absolute path to a local branch
1077
 
        # turn it into a url
1078
 
        if parent.startswith('/'):
1079
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1080
 
        try:
1081
 
            return urlutils.join(self.base[:-1], parent)
1082
 
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
1084
 
 
1085
 
    def _get_parent_location(self):
1086
 
        raise NotImplementedError(self._get_parent_location)
 
758
        raise NotImplementedError(self.get_parent)
1087
759
 
1088
760
    def _set_config_location(self, name, url, config=None,
1089
761
                             make_relative=False):
1103
775
            location = None
1104
776
        return location
1105
777
 
1106
 
    def get_child_submit_format(self):
1107
 
        """Return the preferred format of submissions to this branch."""
1108
 
        return self.get_config().get_user_option("child_submit_format")
1109
 
 
1110
778
    def get_submit_branch(self):
1111
779
        """Return the submit location of the branch.
1112
780
 
1129
797
    def get_public_branch(self):
1130
798
        """Return the public location of the branch.
1131
799
 
1132
 
        This is used by merge directives.
 
800
        This is is used by merge directives.
1133
801
        """
1134
802
        return self._get_config_location('public_branch')
1135
803
 
1151
819
        """Set a new push location for this branch."""
1152
820
        raise NotImplementedError(self.set_push_location)
1153
821
 
1154
 
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1155
 
        """Run the post_change_branch_tip hooks."""
1156
 
        hooks = Branch.hooks['post_change_branch_tip']
1157
 
        if not hooks:
1158
 
            return
1159
 
        new_revno, new_revid = self.last_revision_info()
1160
 
        params = ChangeBranchTipParams(
1161
 
            self, old_revno, new_revno, old_revid, new_revid)
1162
 
        for hook in hooks:
1163
 
            hook(params)
1164
 
 
1165
 
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1166
 
        """Run the pre_change_branch_tip hooks."""
1167
 
        hooks = Branch.hooks['pre_change_branch_tip']
1168
 
        if not hooks:
1169
 
            return
1170
 
        old_revno, old_revid = self.last_revision_info()
1171
 
        params = ChangeBranchTipParams(
1172
 
            self, old_revno, new_revno, old_revid, new_revid)
1173
 
        for hook in hooks:
1174
 
            hook(params)
 
822
    def set_parent(self, url):
 
823
        raise NotImplementedError(self.set_parent)
1175
824
 
1176
825
    @needs_write_lock
1177
826
    def update(self):
1178
 
        """Synchronise this branch with the master branch if any.
 
827
        """Synchronise this branch with the master branch if any. 
1179
828
 
1180
829
        :return: None or the last_revision pivoted out during the update.
1181
830
        """
1188
837
        """
1189
838
        if revno != 0:
1190
839
            self.check_real_revno(revno)
1191
 
 
 
840
            
1192
841
    def check_real_revno(self, revno):
1193
842
        """\
1194
843
        Check whether a revno corresponds to a real revision.
1198
847
            raise errors.InvalidRevisionNumber(revno)
1199
848
 
1200
849
    @needs_read_lock
1201
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
850
    def clone(self, to_bzrdir, revision_id=None):
1202
851
        """Clone this branch into to_bzrdir preserving all semantic values.
1203
 
 
1204
 
        Most API users will want 'create_clone_on_transport', which creates a
1205
 
        new bzrdir and branch on the fly.
1206
 
 
 
852
        
1207
853
        revision_id: if not None, the revision history in the new branch will
1208
854
                     be truncated to end with revision_id.
1209
855
        """
1210
856
        result = to_bzrdir.create_branch()
1211
 
        result.lock_write()
1212
 
        try:
1213
 
            if repository_policy is not None:
1214
 
                repository_policy.configure_branch(result)
1215
 
            self.copy_content_into(result, revision_id=revision_id)
1216
 
        finally:
1217
 
            result.unlock()
1218
 
        return result
 
857
        self.copy_content_into(result, revision_id=revision_id)
 
858
        return  result
1219
859
 
1220
860
    @needs_read_lock
1221
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
861
    def sprout(self, to_bzrdir, revision_id=None):
1222
862
        """Create a new line of development from the branch, into to_bzrdir.
1223
863
 
1224
864
        to_bzrdir controls the branch format.
1226
866
        revision_id: if not None, the revision history in the new branch will
1227
867
                     be truncated to end with revision_id.
1228
868
        """
1229
 
        if (repository_policy is not None and
1230
 
            repository_policy.requires_stacking()):
1231
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
869
        result = to_bzrdir.create_branch()
1233
 
        result.lock_write()
1234
 
        try:
1235
 
            if repository_policy is not None:
1236
 
                repository_policy.configure_branch(result)
1237
 
            self.copy_content_into(result, revision_id=revision_id)
1238
 
            result.set_parent(self.bzrdir.root_transport.base)
1239
 
        finally:
1240
 
            result.unlock()
 
870
        self.copy_content_into(result, revision_id=revision_id)
 
871
        result.set_parent(self.bzrdir.root_transport.base)
1241
872
        return result
1242
873
 
1243
874
    def _synchronize_history(self, destination, revision_id):
1255
886
        source_revno, source_revision_id = self.last_revision_info()
1256
887
        if revision_id is None:
1257
888
            revno, revision_id = source_revno, source_revision_id
 
889
        elif source_revision_id == revision_id:
 
890
            # we know the revno without needing to walk all of history
 
891
            revno = source_revno
1258
892
        else:
1259
 
            graph = self.repository.get_graph()
1260
 
            try:
1261
 
                revno = graph.find_distance_to_null(revision_id, 
1262
 
                    [(source_revision_id, source_revno)])
1263
 
            except errors.GhostRevisionsHaveNoRevno:
1264
 
                # Default to 1, if we can't find anything else
1265
 
                revno = 1
 
893
            # To figure out the revno for a random revision, we need to build
 
894
            # the revision history, and count its length.
 
895
            # We don't care about the order, just how long it is.
 
896
            # Alternatively, we could start at the current location, and count
 
897
            # backwards. But there is no guarantee that we will find it since
 
898
            # it may be a merged revision.
 
899
            revno = len(list(self.repository.iter_reverse_revision_history(
 
900
                                                                revision_id)))
1266
901
        destination.set_last_revision_info(revno, revision_id)
1267
 
 
 
902
    
1268
903
    @needs_read_lock
1269
904
    def copy_content_into(self, destination, revision_id=None):
1270
905
        """Copy the content of self into destination.
1272
907
        revision_id: if not None, the revision history in the new branch will
1273
908
                     be truncated to end with revision_id.
1274
909
        """
1275
 
        self.update_references(destination)
1276
910
        self._synchronize_history(destination, revision_id)
1277
911
        try:
1278
912
            parent = self.get_parent()
1281
915
        else:
1282
916
            if parent:
1283
917
                destination.set_parent(parent)
1284
 
        if self._push_should_merge_tags():
1285
 
            self.tags.merge_to(destination.tags)
1286
 
 
1287
 
    def update_references(self, target):
1288
 
        if not getattr(self._format, 'supports_reference_locations', False):
1289
 
            return
1290
 
        reference_dict = self._get_all_reference_info()
1291
 
        if len(reference_dict) == 0:
1292
 
            return
1293
 
        old_base = self.base
1294
 
        new_base = target.base
1295
 
        target_reference_dict = target._get_all_reference_info()
1296
 
        for file_id, (tree_path, branch_location) in (
1297
 
            reference_dict.items()):
1298
 
            branch_location = urlutils.rebase_url(branch_location,
1299
 
                                                  old_base, new_base)
1300
 
            target_reference_dict.setdefault(
1301
 
                file_id, (tree_path, branch_location))
1302
 
        target._set_all_reference_info(target_reference_dict)
 
918
        self.tags.merge_to(destination.tags)
1303
919
 
1304
920
    @needs_read_lock
1305
 
    def check(self, refs):
 
921
    def check(self):
1306
922
        """Check consistency of the branch.
1307
923
 
1308
924
        In particular this checks that revisions given in the revision-history
1309
 
        do actually match up in the revision graph, and that they're all
 
925
        do actually match up in the revision graph, and that they're all 
1310
926
        present in the repository.
1311
 
 
 
927
        
1312
928
        Callers will typically also want to check the repository.
1313
929
 
1314
 
        :param refs: Calculated refs for this branch as specified by
1315
 
            branch._get_check_refs()
1316
930
        :return: A BranchCheckResult.
1317
931
        """
1318
 
        result = BranchCheckResult(self)
 
932
        mainline_parent_id = None
1319
933
        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
 
934
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
935
                                last_revision_id))
 
936
        real_rev_history.reverse()
 
937
        if len(real_rev_history) != last_revno:
 
938
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
939
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
940
        # TODO: We should probably also check that real_rev_history actually
 
941
        #       matches self.revision_history()
 
942
        for revision_id in real_rev_history:
 
943
            try:
 
944
                revision = self.repository.get_revision(revision_id)
 
945
            except errors.NoSuchRevision, e:
 
946
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
947
                            % revision_id)
 
948
            # In general the first entry on the revision history has no parents.
 
949
            # But it's not illegal for it to have parents listed; this can happen
 
950
            # in imports from Arch when the parents weren't reachable.
 
951
            if mainline_parent_id is not None:
 
952
                if mainline_parent_id not in revision.parent_ids:
 
953
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
954
                                        "parents of {%s}"
 
955
                                        % (mainline_parent_id, revision_id))
 
956
            mainline_parent_id = revision_id
 
957
        return BranchCheckResult(self)
1331
958
 
1332
959
    def _get_checkout_format(self):
1333
960
        """Return the most suitable metadir for a checkout of this branch.
1342
969
            format.set_branch_format(self._format)
1343
970
        return format
1344
971
 
1345
 
    def create_clone_on_transport(self, to_transport, revision_id=None,
1346
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1347
 
        """Create a clone of this branch and its bzrdir.
1348
 
 
1349
 
        :param to_transport: The transport to clone onto.
1350
 
        :param revision_id: The revision id to use as tip in the new branch.
1351
 
            If None the tip is obtained from this branch.
1352
 
        :param stacked_on: An optional URL to stack the clone on.
1353
 
        :param create_prefix: Create any missing directories leading up to
1354
 
            to_transport.
1355
 
        :param use_existing_dir: Use an existing directory if one exists.
1356
 
        """
1357
 
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1358
 
        # clone call. Or something. 20090224 RBC/spiv.
1359
 
        if revision_id is None:
1360
 
            revision_id = self.last_revision()
1361
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1362
 
            revision_id=revision_id, stacked_on=stacked_on,
1363
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1364
 
        return dir_to.open_branch()
1365
 
 
1366
972
    def create_checkout(self, to_location, revision_id=None,
1367
973
                        lightweight=False, accelerator_tree=None,
1368
974
                        hardlink=False):
1369
975
        """Create a checkout of a branch.
1370
 
 
 
976
        
1371
977
        :param to_location: The url to produce the checkout at
1372
978
        :param revision_id: The revision to check out
1373
979
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1385
991
        if lightweight:
1386
992
            format = self._get_checkout_format()
1387
993
            checkout = format.initialize_on_transport(t)
1388
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1389
 
                target_branch=self)
 
994
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1390
995
        else:
1391
996
            format = self._get_checkout_format()
1392
997
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1393
998
                to_location, force_new_tree=False, format=format)
1394
999
            checkout = checkout_branch.bzrdir
1395
1000
            checkout_branch.bind(self)
1396
 
            # pull up to the specified revision_id to set the initial
 
1001
            # pull up to the specified revision_id to set the initial 
1397
1002
            # branch tip correctly, and seed it with history.
1398
1003
            checkout_branch.pull(self, stop_revision=revision_id)
1399
1004
            from_branch=None
1421
1026
        reconciler.reconcile()
1422
1027
        return reconciler
1423
1028
 
1424
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1029
    def reference_parent(self, file_id, path):
1425
1030
        """Return the parent branch for a tree-reference file_id
1426
1031
        :param file_id: The file_id of the tree reference
1427
1032
        :param path: The path of the file_id in the tree
1428
1033
        :return: A branch associated with the file_id
1429
1034
        """
1430
1035
        # FIXME should provide multiple branches, based on config
1431
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1432
 
                           possible_transports=possible_transports)
 
1036
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1433
1037
 
1434
1038
    def supports_tags(self):
1435
1039
        return self._format.supports_tags()
1436
1040
 
1437
 
    def automatic_tag_name(self, revision_id):
1438
 
        """Try to automatically find the tag name for a revision.
1439
 
 
1440
 
        :param revision_id: Revision id of the revision.
1441
 
        :return: A tag name or None if no tag name could be determined.
1442
 
        """
1443
 
        for hook in Branch.hooks['automatic_tag_name']:
1444
 
            ret = hook(self, revision_id)
1445
 
            if ret is not None:
1446
 
                return ret
1447
 
        return None
1448
 
 
1449
1041
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1450
1042
                                         other_branch):
1451
1043
        """Ensure that revision_b is a descendant of revision_a.
1452
1044
 
1453
1045
        This is a helper function for update_revisions.
1454
 
 
 
1046
        
1455
1047
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1456
1048
        :returns: True if revision_b is a descendant of revision_a.
1457
1049
        """
1467
1059
 
1468
1060
    def _revision_relations(self, revision_a, revision_b, graph):
1469
1061
        """Determine the relationship between two revisions.
1470
 
 
 
1062
        
1471
1063
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1472
1064
        """
1473
1065
        heads = graph.heads([revision_a, revision_b])
1490
1082
     * a format string,
1491
1083
     * an open routine.
1492
1084
 
1493
 
    Formats are placed in an dict by their format string for reference
 
1085
    Formats are placed in an dict by their format string for reference 
1494
1086
    during branch opening. Its not required that these be instances, they
1495
 
    can be classes themselves with class methods - it simply depends on
 
1087
    can be classes themselves with class methods - it simply depends on 
1496
1088
    whether state is needed for a given format or not.
1497
1089
 
1498
1090
    Once a format is deprecated, just deprecate the initialize and open
1499
 
    methods on the format class. Do not deprecate the object, as the
 
1091
    methods on the format class. Do not deprecate the object, as the 
1500
1092
    object will be created every time regardless.
1501
1093
    """
1502
1094
 
1506
1098
    _formats = {}
1507
1099
    """The known formats."""
1508
1100
 
1509
 
    can_set_append_revisions_only = True
1510
 
 
1511
1101
    def __eq__(self, other):
1512
1102
        return self.__class__ is other.__class__
1513
1103
 
1515
1105
        return not (self == other)
1516
1106
 
1517
1107
    @classmethod
1518
 
    def find_format(klass, a_bzrdir, name=None):
 
1108
    def find_format(klass, a_bzrdir):
1519
1109
        """Return the format for the branch object in a_bzrdir."""
1520
1110
        try:
1521
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1522
 
            format_string = transport.get_bytes("format")
 
1111
            transport = a_bzrdir.get_branch_transport(None)
 
1112
            format_string = transport.get("format").read()
1523
1113
            return klass._formats[format_string]
1524
1114
        except errors.NoSuchFile:
1525
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1115
            raise errors.NotBranchError(path=transport.base)
1526
1116
        except KeyError:
1527
1117
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1528
1118
 
1564
1154
        """Return the short format description for this format."""
1565
1155
        raise NotImplementedError(self.get_format_description)
1566
1156
 
1567
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1568
 
        hooks = Branch.hooks['post_branch_init']
1569
 
        if not hooks:
1570
 
            return
1571
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1572
 
        for hook in hooks:
1573
 
            hook(params)
1574
 
 
1575
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1576
 
                           lock_type='metadir', set_format=True):
 
1157
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1158
                           set_format=True):
1577
1159
        """Initialize a branch in a bzrdir, with specified files
1578
1160
 
1579
1161
        :param a_bzrdir: The bzrdir to initialize the branch in
1580
1162
        :param utf8_files: The files to create as a list of
1581
1163
            (filename, content) tuples
1582
 
        :param name: Name of colocated branch to create, if any
1583
1164
        :param set_format: If True, set the format with
1584
1165
            self.get_format_string.  (BzrBranch4 has its format set
1585
1166
            elsewhere)
1586
1167
        :return: a branch in this format
1587
1168
        """
1588
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1589
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1169
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1170
        branch_transport = a_bzrdir.get_branch_transport(self)
1590
1171
        lock_map = {
1591
1172
            'metadir': ('lock', lockdir.LockDir),
1592
1173
            'branch4': ('branch-lock', lockable_files.TransportLock),
1595
1176
        control_files = lockable_files.LockableFiles(branch_transport,
1596
1177
            lock_name, lock_class)
1597
1178
        control_files.create_lock()
1598
 
        try:
1599
 
            control_files.lock_write()
1600
 
        except errors.LockContention:
1601
 
            if lock_type != 'branch4':
1602
 
                raise
1603
 
            lock_taken = False
1604
 
        else:
1605
 
            lock_taken = True
 
1179
        control_files.lock_write()
1606
1180
        if set_format:
1607
1181
            utf8_files += [('format', self.get_format_string())]
1608
1182
        try:
1611
1185
                    filename, content,
1612
1186
                    mode=a_bzrdir._get_file_mode())
1613
1187
        finally:
1614
 
            if lock_taken:
1615
 
                control_files.unlock()
1616
 
        branch = self.open(a_bzrdir, name, _found=True)
1617
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1618
 
        return branch
 
1188
            control_files.unlock()
 
1189
        return self.open(a_bzrdir, _found=True)
1619
1190
 
1620
 
    def initialize(self, a_bzrdir, name=None):
1621
 
        """Create a branch of this format in a_bzrdir.
1622
 
        
1623
 
        :param name: Name of the colocated branch to create.
1624
 
        """
 
1191
    def initialize(self, a_bzrdir):
 
1192
        """Create a branch of this format in a_bzrdir."""
1625
1193
        raise NotImplementedError(self.initialize)
1626
1194
 
1627
1195
    def is_supported(self):
1628
1196
        """Is this format supported?
1629
1197
 
1630
1198
        Supported formats can be initialized and opened.
1631
 
        Unsupported formats may not support initialization or committing or
 
1199
        Unsupported formats may not support initialization or committing or 
1632
1200
        some other features depending on the reason for not being supported.
1633
1201
        """
1634
1202
        return True
1635
1203
 
1636
 
    def make_tags(self, branch):
1637
 
        """Create a tags object for branch.
1638
 
 
1639
 
        This method is on BranchFormat, because BranchFormats are reflected
1640
 
        over the wire via network_name(), whereas full Branch instances require
1641
 
        multiple VFS method calls to operate at all.
1642
 
 
1643
 
        The default implementation returns a disabled-tags instance.
1644
 
 
1645
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1646
 
        on a RemoteBranch.
1647
 
        """
1648
 
        return DisabledTags(branch)
1649
 
 
1650
 
    def network_name(self):
1651
 
        """A simple byte string uniquely identifying this format for RPC calls.
1652
 
 
1653
 
        MetaDir branch formats use their disk format string to identify the
1654
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1655
 
        foreign formats like svn/git and hg should use some marker which is
1656
 
        unique and immutable.
1657
 
        """
1658
 
        raise NotImplementedError(self.network_name)
1659
 
 
1660
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1204
    def open(self, a_bzrdir, _found=False):
1661
1205
        """Return the branch object for a_bzrdir
1662
1206
 
1663
 
        :param a_bzrdir: A BzrDir that contains a branch.
1664
 
        :param name: Name of colocated branch to open
1665
 
        :param _found: a private parameter, do not use it. It is used to
1666
 
            indicate if format probing has already be done.
1667
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1668
 
            (if there are any).  Default is to open fallbacks.
 
1207
        _found is a private parameter, do not use it. It is used to indicate
 
1208
               if format probing has already be done.
1669
1209
        """
1670
1210
        raise NotImplementedError(self.open)
1671
1211
 
1672
1212
    @classmethod
1673
1213
    def register_format(klass, format):
1674
 
        """Register a metadir format."""
1675
1214
        klass._formats[format.get_format_string()] = format
1676
 
        # Metadir formats have a network name of their format string, and get
1677
 
        # registered as class factories.
1678
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1679
1215
 
1680
1216
    @classmethod
1681
1217
    def set_default_format(klass, format):
1682
1218
        klass._default_format = format
1683
1219
 
1684
 
    def supports_set_append_revisions_only(self):
1685
 
        """True if this format supports set_append_revisions_only."""
1686
 
        return False
1687
 
 
1688
1220
    def supports_stacking(self):
1689
1221
        """True if this format records a stacked-on branch."""
1690
1222
        return False
1694
1226
        del klass._formats[format.get_format_string()]
1695
1227
 
1696
1228
    def __str__(self):
1697
 
        return self.get_format_description().rstrip()
 
1229
        return self.get_format_string().rstrip()
1698
1230
 
1699
1231
    def supports_tags(self):
1700
1232
        """True if this format supports tags stored in the branch"""
1703
1235
 
1704
1236
class BranchHooks(Hooks):
1705
1237
    """A dictionary mapping hook name to a list of callables for branch hooks.
1706
 
 
 
1238
    
1707
1239
    e.g. ['set_rh'] Is the list of items to be called when the
1708
1240
    set_revision_history function is invoked.
1709
1241
    """
1715
1247
        notified.
1716
1248
        """
1717
1249
        Hooks.__init__(self)
1718
 
        self.create_hook(HookPoint('set_rh',
1719
 
            "Invoked whenever the revision history has been set via "
1720
 
            "set_revision_history. The api signature is (branch, "
1721
 
            "revision_history), and the branch will be write-locked. "
1722
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1723
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1724
 
        self.create_hook(HookPoint('open',
1725
 
            "Called with the Branch object that has been opened after a "
1726
 
            "branch is opened.", (1, 8), None))
1727
 
        self.create_hook(HookPoint('post_push',
1728
 
            "Called after a push operation completes. post_push is called "
1729
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1730
 
            "bzr client.", (0, 15), None))
1731
 
        self.create_hook(HookPoint('post_pull',
1732
 
            "Called after a pull operation completes. post_pull is called "
1733
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1734
 
            "bzr client.", (0, 15), None))
1735
 
        self.create_hook(HookPoint('pre_commit',
1736
 
            "Called after a commit is calculated but before it is is "
1737
 
            "completed. pre_commit is called with (local, master, old_revno, "
1738
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1739
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1740
 
            "tree_delta is a TreeDelta object describing changes from the "
1741
 
            "basis revision. hooks MUST NOT modify this delta. "
1742
 
            " future_tree is an in-memory tree obtained from "
1743
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1744
 
            "tree.", (0,91), None))
1745
 
        self.create_hook(HookPoint('post_commit',
1746
 
            "Called in the bzr client after a commit has completed. "
1747
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1748
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1749
 
            "commit to a branch.", (0, 15), None))
1750
 
        self.create_hook(HookPoint('post_uncommit',
1751
 
            "Called in the bzr client after an uncommit completes. "
1752
 
            "post_uncommit is called with (local, master, old_revno, "
1753
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1754
 
            "or None, master is the target branch, and an empty branch "
1755
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1756
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1757
 
            "Called in bzr client and server before a change to the tip of a "
1758
 
            "branch is made. pre_change_branch_tip is called with a "
1759
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1760
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1761
 
        self.create_hook(HookPoint('post_change_branch_tip',
1762
 
            "Called in bzr client and server after a change to the tip of a "
1763
 
            "branch is made. post_change_branch_tip is called with a "
1764
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1765
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1766
 
        self.create_hook(HookPoint('transform_fallback_location',
1767
 
            "Called when a stacked branch is activating its fallback "
1768
 
            "locations. transform_fallback_location is called with (branch, "
1769
 
            "url), and should return a new url. Returning the same url "
1770
 
            "allows it to be used as-is, returning a different one can be "
1771
 
            "used to cause the branch to stack on a closer copy of that "
1772
 
            "fallback_location. Note that the branch cannot have history "
1773
 
            "accessing methods called on it during this hook because the "
1774
 
            "fallback locations have not been activated. When there are "
1775
 
            "multiple hooks installed for transform_fallback_location, "
1776
 
            "all are called with the url returned from the previous hook."
1777
 
            "The order is however undefined.", (1, 9), None))
1778
 
        self.create_hook(HookPoint('automatic_tag_name',
1779
 
            "Called to determine an automatic tag name for a revision."
1780
 
            "automatic_tag_name is called with (branch, revision_id) and "
1781
 
            "should return a tag name or None if no tag name could be "
1782
 
            "determined. The first non-None tag name returned will be used.",
1783
 
            (2, 2), None))
1784
 
        self.create_hook(HookPoint('post_branch_init',
1785
 
            "Called after new branch initialization completes. "
1786
 
            "post_branch_init is called with a "
1787
 
            "bzrlib.branch.BranchInitHookParams. "
1788
 
            "Note that init, branch and checkout (both heavyweight and "
1789
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1790
 
        self.create_hook(HookPoint('post_switch',
1791
 
            "Called after a checkout switches branch. "
1792
 
            "post_switch is called with a "
1793
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1794
 
 
 
1250
        # Introduced in 0.15:
 
1251
        # invoked whenever the revision history has been set
 
1252
        # with set_revision_history. The api signature is
 
1253
        # (branch, revision_history), and the branch will
 
1254
        # be write-locked.
 
1255
        self['set_rh'] = []
 
1256
        # Invoked after a branch is opened. The api signature is (branch).
 
1257
        self['open'] = []
 
1258
        # invoked after a push operation completes.
 
1259
        # the api signature is
 
1260
        # (push_result)
 
1261
        # containing the members
 
1262
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1263
        # where local is the local target branch or None, master is the target 
 
1264
        # master branch, and the rest should be self explanatory. The source
 
1265
        # is read locked and the target branches write locked. Source will
 
1266
        # be the local low-latency branch.
 
1267
        self['post_push'] = []
 
1268
        # invoked after a pull operation completes.
 
1269
        # the api signature is
 
1270
        # (pull_result)
 
1271
        # containing the members
 
1272
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1273
        # where local is the local branch or None, master is the target 
 
1274
        # master branch, and the rest should be self explanatory. The source
 
1275
        # is read locked and the target branches write locked. The local
 
1276
        # branch is the low-latency branch.
 
1277
        self['post_pull'] = []
 
1278
        # invoked before a commit operation takes place.
 
1279
        # the api signature is
 
1280
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1281
        #  tree_delta, future_tree).
 
1282
        # old_revid is NULL_REVISION for the first commit to a branch
 
1283
        # tree_delta is a TreeDelta object describing changes from the basis
 
1284
        # revision, hooks MUST NOT modify this delta
 
1285
        # future_tree is an in-memory tree obtained from
 
1286
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1287
        self['pre_commit'] = []
 
1288
        # invoked after a commit operation completes.
 
1289
        # the api signature is 
 
1290
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1291
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1292
        self['post_commit'] = []
 
1293
        # invoked after a uncommit operation completes.
 
1294
        # the api signature is
 
1295
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1296
        # local is the local branch or None, master is the target branch,
 
1297
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1298
        self['post_uncommit'] = []
 
1299
        # Introduced in 1.6
 
1300
        # Invoked before the tip of a branch changes.
 
1301
        # the api signature is
 
1302
        # (params) where params is a ChangeBranchTipParams with the members
 
1303
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1304
        self['pre_change_branch_tip'] = []
 
1305
        # Introduced in 1.4
 
1306
        # Invoked after the tip of a branch changes.
 
1307
        # the api signature is
 
1308
        # (params) where params is a ChangeBranchTipParams with the members
 
1309
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1310
        self['post_change_branch_tip'] = []
 
1311
        # Introduced in 1.9
 
1312
        # Invoked when a stacked branch activates its fallback locations and
 
1313
        # allows the transformation of the url of said location.
 
1314
        # the api signature is
 
1315
        # (branch, url) where branch is the branch having its fallback
 
1316
        # location activated and url is the url for the fallback location.
 
1317
        # The hook should return a url.
 
1318
        self['transform_fallback_location'] = []
1795
1319
 
1796
1320
 
1797
1321
# install the default hooks into the Branch class.
1829
1353
 
1830
1354
    def __eq__(self, other):
1831
1355
        return self.__dict__ == other.__dict__
1832
 
 
 
1356
    
1833
1357
    def __repr__(self):
1834
1358
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1835
 
            self.__class__.__name__, self.branch,
 
1359
            self.__class__.__name__, self.branch, 
1836
1360
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1837
1361
 
1838
1362
 
1839
 
class BranchInitHookParams(object):
1840
 
    """Object holding parameters passed to *_branch_init hooks.
1841
 
 
1842
 
    There are 4 fields that hooks may wish to access:
1843
 
 
1844
 
    :ivar format: the branch format
1845
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
 
    :ivar name: name of colocated branch, if any (or None)
1847
 
    :ivar branch: the branch created
1848
 
 
1849
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
 
    the checkout, hence they are different from the corresponding fields in
1851
 
    branch, which refer to the original branch.
1852
 
    """
1853
 
 
1854
 
    def __init__(self, format, a_bzrdir, name, branch):
1855
 
        """Create a group of BranchInitHook parameters.
1856
 
 
1857
 
        :param format: the branch format
1858
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1859
 
            initialized
1860
 
        :param name: name of colocated branch, if any (or None)
1861
 
        :param branch: the branch created
1862
 
 
1863
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1864
 
        to the checkout, hence they are different from the corresponding fields
1865
 
        in branch, which refer to the original branch.
1866
 
        """
1867
 
        self.format = format
1868
 
        self.bzrdir = a_bzrdir
1869
 
        self.name = name
1870
 
        self.branch = branch
1871
 
 
1872
 
    def __eq__(self, other):
1873
 
        return self.__dict__ == other.__dict__
1874
 
 
1875
 
    def __repr__(self):
1876
 
        if self.branch:
1877
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1878
 
        else:
1879
 
            return "<%s of format:%s bzrdir:%s>" % (
1880
 
                self.__class__.__name__, self.branch,
1881
 
                self.format, self.bzrdir)
1882
 
 
1883
 
 
1884
 
class SwitchHookParams(object):
1885
 
    """Object holding parameters passed to *_switch hooks.
1886
 
 
1887
 
    There are 4 fields that hooks may wish to access:
1888
 
 
1889
 
    :ivar control_dir: BzrDir of the checkout to change
1890
 
    :ivar to_branch: branch that the checkout is to reference
1891
 
    :ivar force: skip the check for local commits in a heavy checkout
1892
 
    :ivar revision_id: revision ID to switch to (or None)
1893
 
    """
1894
 
 
1895
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1896
 
        """Create a group of SwitchHook parameters.
1897
 
 
1898
 
        :param control_dir: BzrDir of the checkout to change
1899
 
        :param to_branch: branch that the checkout is to reference
1900
 
        :param force: skip the check for local commits in a heavy checkout
1901
 
        :param revision_id: revision ID to switch to (or None)
1902
 
        """
1903
 
        self.control_dir = control_dir
1904
 
        self.to_branch = to_branch
1905
 
        self.force = force
1906
 
        self.revision_id = revision_id
1907
 
 
1908
 
    def __eq__(self, other):
1909
 
        return self.__dict__ == other.__dict__
1910
 
 
1911
 
    def __repr__(self):
1912
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
 
            self.control_dir, self.to_branch,
1914
 
            self.revision_id)
1915
 
 
1916
 
 
1917
1363
class BzrBranchFormat4(BranchFormat):
1918
1364
    """Bzr branch format 4.
1919
1365
 
1926
1372
        """See BranchFormat.get_format_description()."""
1927
1373
        return "Branch format 4"
1928
1374
 
1929
 
    def initialize(self, a_bzrdir, name=None):
 
1375
    def initialize(self, a_bzrdir):
1930
1376
        """Create a branch of this format in a_bzrdir."""
1931
1377
        utf8_files = [('revision-history', ''),
1932
1378
                      ('branch-name', ''),
1933
1379
                      ]
1934
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1380
        return self._initialize_helper(a_bzrdir, utf8_files,
1935
1381
                                       lock_type='branch4', set_format=False)
1936
1382
 
1937
1383
    def __init__(self):
1938
1384
        super(BzrBranchFormat4, self).__init__()
1939
1385
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1940
1386
 
1941
 
    def network_name(self):
1942
 
        """The network name for this format is the control dirs disk label."""
1943
 
        return self._matchingbzrdir.get_format_string()
 
1387
    def open(self, a_bzrdir, _found=False):
 
1388
        """Return the branch object for a_bzrdir
1944
1389
 
1945
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1946
 
        """See BranchFormat.open()."""
 
1390
        _found is a private parameter, do not use it. It is used to indicate
 
1391
               if format probing has already be done.
 
1392
        """
1947
1393
        if not _found:
1948
1394
            # we are being called directly and must probe.
1949
1395
            raise NotImplementedError
1950
1396
        return BzrBranch(_format=self,
1951
1397
                         _control_files=a_bzrdir._control_files,
1952
1398
                         a_bzrdir=a_bzrdir,
1953
 
                         name=name,
1954
1399
                         _repository=a_bzrdir.open_repository())
1955
1400
 
1956
1401
    def __str__(self):
1964
1409
        """What class to instantiate on open calls."""
1965
1410
        raise NotImplementedError(self._branch_class)
1966
1411
 
1967
 
    def network_name(self):
1968
 
        """A simple byte string uniquely identifying this format for RPC calls.
 
1412
    def open(self, a_bzrdir, _found=False):
 
1413
        """Return the branch object for a_bzrdir.
1969
1414
 
1970
 
        Metadir branch formats use their format string.
 
1415
        _found is a private parameter, do not use it. It is used to indicate
 
1416
               if format probing has already be done.
1971
1417
        """
1972
 
        return self.get_format_string()
1973
 
 
1974
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1975
 
        """See BranchFormat.open()."""
1976
1418
        if not _found:
1977
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1419
            format = BranchFormat.find_format(a_bzrdir)
1978
1420
            if format.__class__ != self.__class__:
1979
1421
                raise AssertionError("wrong format %r found for %r" %
1980
1422
                    (format, self))
1981
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1982
1423
        try:
 
1424
            transport = a_bzrdir.get_branch_transport(None)
1983
1425
            control_files = lockable_files.LockableFiles(transport, 'lock',
1984
1426
                                                         lockdir.LockDir)
1985
1427
            return self._branch_class()(_format=self,
1986
1428
                              _control_files=control_files,
1987
 
                              name=name,
1988
1429
                              a_bzrdir=a_bzrdir,
1989
 
                              _repository=a_bzrdir.find_repository(),
1990
 
                              ignore_fallbacks=ignore_fallbacks)
 
1430
                              _repository=a_bzrdir.find_repository())
1991
1431
        except errors.NoSuchFile:
1992
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1432
            raise errors.NotBranchError(path=transport.base)
1993
1433
 
1994
1434
    def __init__(self):
1995
1435
        super(BranchFormatMetadir, self).__init__()
2023
1463
    def get_format_description(self):
2024
1464
        """See BranchFormat.get_format_description()."""
2025
1465
        return "Branch format 5"
2026
 
 
2027
 
    def initialize(self, a_bzrdir, name=None):
 
1466
        
 
1467
    def initialize(self, a_bzrdir):
2028
1468
        """Create a branch of this format in a_bzrdir."""
2029
1469
        utf8_files = [('revision-history', ''),
2030
1470
                      ('branch-name', ''),
2031
1471
                      ]
2032
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1472
        return self._initialize_helper(a_bzrdir, utf8_files)
2033
1473
 
2034
1474
    def supports_tags(self):
2035
1475
        return False
2057
1497
        """See BranchFormat.get_format_description()."""
2058
1498
        return "Branch format 6"
2059
1499
 
2060
 
    def initialize(self, a_bzrdir, name=None):
2061
 
        """Create a branch of this format in a_bzrdir."""
2062
 
        utf8_files = [('last-revision', '0 null:\n'),
2063
 
                      ('branch.conf', ''),
2064
 
                      ('tags', ''),
2065
 
                      ]
2066
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2067
 
 
2068
 
    def make_tags(self, branch):
2069
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2070
 
        return BasicTags(branch)
2071
 
 
2072
 
    def supports_set_append_revisions_only(self):
2073
 
        return True
2074
 
 
2075
 
 
2076
 
class BzrBranchFormat8(BranchFormatMetadir):
2077
 
    """Metadir format supporting storing locations of subtree branches."""
2078
 
 
2079
 
    def _branch_class(self):
2080
 
        return BzrBranch8
2081
 
 
2082
 
    def get_format_string(self):
2083
 
        """See BranchFormat.get_format_string()."""
2084
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2085
 
 
2086
 
    def get_format_description(self):
2087
 
        """See BranchFormat.get_format_description()."""
2088
 
        return "Branch format 8"
2089
 
 
2090
 
    def initialize(self, a_bzrdir, name=None):
2091
 
        """Create a branch of this format in a_bzrdir."""
2092
 
        utf8_files = [('last-revision', '0 null:\n'),
2093
 
                      ('branch.conf', ''),
2094
 
                      ('tags', ''),
2095
 
                      ('references', '')
2096
 
                      ]
2097
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2098
 
 
2099
 
    def __init__(self):
2100
 
        super(BzrBranchFormat8, self).__init__()
2101
 
        self._matchingbzrdir.repository_format = \
2102
 
            RepositoryFormatKnitPack5RichRoot()
2103
 
 
2104
 
    def make_tags(self, branch):
2105
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2106
 
        return BasicTags(branch)
2107
 
 
2108
 
    def supports_set_append_revisions_only(self):
2109
 
        return True
2110
 
 
2111
 
    def supports_stacking(self):
2112
 
        return True
2113
 
 
2114
 
    supports_reference_locations = True
2115
 
 
2116
 
 
2117
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1500
    def initialize(self, a_bzrdir):
 
1501
        """Create a branch of this format in a_bzrdir."""
 
1502
        utf8_files = [('last-revision', '0 null:\n'),
 
1503
                      ('branch.conf', ''),
 
1504
                      ('tags', ''),
 
1505
                      ]
 
1506
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1507
 
 
1508
 
 
1509
class BzrBranchFormat7(BranchFormatMetadir):
2118
1510
    """Branch format with last-revision, tags, and a stacked location pointer.
2119
1511
 
2120
1512
    The stacked location pointer is passed down to the repository and requires
2123
1515
    This format was introduced in bzr 1.6.
2124
1516
    """
2125
1517
 
2126
 
    def initialize(self, a_bzrdir, name=None):
2127
 
        """Create a branch of this format in a_bzrdir."""
2128
 
        utf8_files = [('last-revision', '0 null:\n'),
2129
 
                      ('branch.conf', ''),
2130
 
                      ('tags', ''),
2131
 
                      ]
2132
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2133
 
 
2134
1518
    def _branch_class(self):
2135
1519
        return BzrBranch7
2136
1520
 
2142
1526
        """See BranchFormat.get_format_description()."""
2143
1527
        return "Branch format 7"
2144
1528
 
2145
 
    def supports_set_append_revisions_only(self):
 
1529
    def initialize(self, a_bzrdir):
 
1530
        """Create a branch of this format in a_bzrdir."""
 
1531
        utf8_files = [('last-revision', '0 null:\n'),
 
1532
                      ('branch.conf', ''),
 
1533
                      ('tags', ''),
 
1534
                      ]
 
1535
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1536
 
 
1537
    def __init__(self):
 
1538
        super(BzrBranchFormat7, self).__init__()
 
1539
        self._matchingbzrdir.repository_format = \
 
1540
            RepositoryFormatKnitPack5RichRoot()
 
1541
 
 
1542
    def supports_stacking(self):
2146
1543
        return True
2147
1544
 
2148
 
    supports_reference_locations = False
2149
 
 
2150
1545
 
2151
1546
class BranchReferenceFormat(BranchFormat):
2152
1547
    """Bzr branch reference format.
2170
1565
    def get_reference(self, a_bzrdir):
2171
1566
        """See BranchFormat.get_reference()."""
2172
1567
        transport = a_bzrdir.get_branch_transport(None)
2173
 
        return transport.get_bytes('location')
 
1568
        return transport.get('location').read()
2174
1569
 
2175
1570
    def set_reference(self, a_bzrdir, to_branch):
2176
1571
        """See BranchFormat.set_reference()."""
2177
1572
        transport = a_bzrdir.get_branch_transport(None)
2178
1573
        location = transport.put_bytes('location', to_branch.base)
2179
1574
 
2180
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1575
    def initialize(self, a_bzrdir, target_branch=None):
2181
1576
        """Create a branch of this format in a_bzrdir."""
2182
1577
        if target_branch is None:
2183
1578
            # this format does not implement branch itself, thus the implicit
2184
1579
            # creation contract must see it as uninitializable
2185
1580
            raise errors.UninitializableFormat(self)
2186
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2187
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1581
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1582
        branch_transport = a_bzrdir.get_branch_transport(self)
2188
1583
        branch_transport.put_bytes('location',
2189
 
            target_branch.bzrdir.user_url)
 
1584
            target_branch.bzrdir.root_transport.base)
2190
1585
        branch_transport.put_bytes('format', self.get_format_string())
2191
 
        branch = self.open(
2192
 
            a_bzrdir, name, _found=True,
 
1586
        return self.open(
 
1587
            a_bzrdir, _found=True,
2193
1588
            possible_transports=[target_branch.bzrdir.root_transport])
2194
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2195
 
        return branch
2196
1589
 
2197
1590
    def __init__(self):
2198
1591
        super(BranchReferenceFormat, self).__init__()
2201
1594
 
2202
1595
    def _make_reference_clone_function(format, a_branch):
2203
1596
        """Create a clone() routine for a branch dynamically."""
2204
 
        def clone(to_bzrdir, revision_id=None,
2205
 
            repository_policy=None):
 
1597
        def clone(to_bzrdir, revision_id=None):
2206
1598
            """See Branch.clone()."""
2207
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1599
            return format.initialize(to_bzrdir, a_branch)
2208
1600
            # cannot obey revision_id limits when cloning a reference ...
2209
1601
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2210
1602
            # emit some sort of warning/error to the caller ?!
2211
1603
        return clone
2212
1604
 
2213
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2214
 
             possible_transports=None, ignore_fallbacks=False):
 
1605
    def open(self, a_bzrdir, _found=False, location=None,
 
1606
             possible_transports=None):
2215
1607
        """Return the branch that the branch reference in a_bzrdir points at.
2216
1608
 
2217
 
        :param a_bzrdir: A BzrDir that contains a branch.
2218
 
        :param name: Name of colocated branch to open, if any
2219
 
        :param _found: a private parameter, do not use it. It is used to
2220
 
            indicate if format probing has already be done.
2221
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2222
 
            (if there are any).  Default is to open fallbacks.
2223
 
        :param location: The location of the referenced branch.  If
2224
 
            unspecified, this will be determined from the branch reference in
2225
 
            a_bzrdir.
2226
 
        :param possible_transports: An optional reusable transports list.
 
1609
        _found is a private parameter, do not use it. It is used to indicate
 
1610
               if format probing has already be done.
2227
1611
        """
2228
1612
        if not _found:
2229
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1613
            format = BranchFormat.find_format(a_bzrdir)
2230
1614
            if format.__class__ != self.__class__:
2231
1615
                raise AssertionError("wrong format %r found for %r" %
2232
1616
                    (format, self))
2234
1618
            location = self.get_reference(a_bzrdir)
2235
1619
        real_bzrdir = bzrdir.BzrDir.open(
2236
1620
            location, possible_transports=possible_transports)
2237
 
        result = real_bzrdir.open_branch(name=name, 
2238
 
            ignore_fallbacks=ignore_fallbacks)
 
1621
        result = real_bzrdir.open_branch()
2239
1622
        # this changes the behaviour of result.clone to create a new reference
2240
1623
        # rather than a copy of the content of the branch.
2241
1624
        # I did not use a proxy object because that needs much more extensive
2248
1631
        return result
2249
1632
 
2250
1633
 
2251
 
network_format_registry = registry.FormatRegistry()
2252
 
"""Registry of formats indexed by their network name.
2253
 
 
2254
 
The network name for a branch format is an identifier that can be used when
2255
 
referring to formats with smart server operations. See
2256
 
BranchFormat.network_name() for more detail.
2257
 
"""
2258
 
 
2259
 
 
2260
1634
# formats which have no format string are not discoverable
2261
1635
# and not independently creatable, so are not registered.
2262
1636
__format5 = BzrBranchFormat5()
2263
1637
__format6 = BzrBranchFormat6()
2264
1638
__format7 = BzrBranchFormat7()
2265
 
__format8 = BzrBranchFormat8()
2266
1639
BranchFormat.register_format(__format5)
2267
1640
BranchFormat.register_format(BranchReferenceFormat())
2268
1641
BranchFormat.register_format(__format6)
2269
1642
BranchFormat.register_format(__format7)
2270
 
BranchFormat.register_format(__format8)
2271
 
BranchFormat.set_default_format(__format7)
 
1643
BranchFormat.set_default_format(__format6)
2272
1644
_legacy_formats = [BzrBranchFormat4(),
2273
 
    ]
2274
 
network_format_registry.register(
2275
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2276
 
 
2277
 
 
2278
 
class BranchWriteLockResult(LogicalLockResult):
2279
 
    """The result of write locking a branch.
2280
 
 
2281
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2282
 
        None.
2283
 
    :ivar unlock: A callable which will unlock the lock.
2284
 
    """
2285
 
 
2286
 
    def __init__(self, unlock, branch_token):
2287
 
        LogicalLockResult.__init__(self, unlock)
2288
 
        self.branch_token = branch_token
2289
 
 
2290
 
    def __repr__(self):
2291
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2292
 
            self.unlock)
2293
 
 
2294
 
 
2295
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1645
                   ]
 
1646
 
 
1647
class BzrBranch(Branch):
2296
1648
    """A branch stored in the actual filesystem.
2297
1649
 
2298
1650
    Note that it's "local" in the context of the filesystem; it doesn't
2299
1651
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
2300
1652
    it's writable, and can be accessed via the normal filesystem API.
2301
1653
 
2302
 
    :ivar _transport: Transport for file operations on this branch's
 
1654
    :ivar _transport: Transport for file operations on this branch's 
2303
1655
        control files, typically pointing to the .bzr/branch directory.
2304
1656
    :ivar repository: Repository for this branch.
2305
 
    :ivar base: The url of the base directory for this branch; the one
 
1657
    :ivar base: The url of the base directory for this branch; the one 
2306
1658
        containing the .bzr directory.
2307
 
    :ivar name: Optional colocated branch name as it exists in the control
2308
 
        directory.
2309
1659
    """
2310
 
 
 
1660
    
2311
1661
    def __init__(self, _format=None,
2312
 
                 _control_files=None, a_bzrdir=None, name=None,
2313
 
                 _repository=None, ignore_fallbacks=False):
 
1662
                 _control_files=None, a_bzrdir=None, _repository=None):
2314
1663
        """Create new branch object at a particular location."""
2315
1664
        if a_bzrdir is None:
2316
1665
            raise ValueError('a_bzrdir must be supplied')
2317
1666
        else:
2318
1667
            self.bzrdir = a_bzrdir
2319
1668
        self._base = self.bzrdir.transport.clone('..').base
2320
 
        self.name = name
2321
1669
        # XXX: We should be able to just do
2322
1670
        #   self.base = self.bzrdir.root_transport.base
2323
1671
        # but this does not quite work yet -- mbp 20080522
2330
1678
        Branch.__init__(self)
2331
1679
 
2332
1680
    def __str__(self):
2333
 
        if self.name is None:
2334
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2335
 
        else:
2336
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2337
 
                self.name)
 
1681
        return '%s(%r)' % (self.__class__.__name__, self.base)
2338
1682
 
2339
1683
    __repr__ = __str__
2340
1684
 
2344
1688
 
2345
1689
    base = property(_get_base, doc="The URL for the root of this branch.")
2346
1690
 
2347
 
    def _get_config(self):
2348
 
        return TransportConfig(self._transport, 'branch.conf')
2349
 
 
2350
1691
    def is_locked(self):
2351
1692
        return self.control_files.is_locked()
2352
1693
 
2353
1694
    def lock_write(self, token=None):
2354
 
        """Lock the branch for write operations.
2355
 
 
2356
 
        :param token: A token to permit reacquiring a previously held and
2357
 
            preserved lock.
2358
 
        :return: A BranchWriteLockResult.
2359
 
        """
2360
 
        if not self.is_locked():
2361
 
            self._note_lock('w')
2362
 
        # All-in-one needs to always unlock/lock.
2363
 
        repo_control = getattr(self.repository, 'control_files', None)
2364
 
        if self.control_files == repo_control or not self.is_locked():
2365
 
            self.repository._warn_if_deprecated(self)
2366
 
            self.repository.lock_write()
2367
 
            took_lock = True
2368
 
        else:
2369
 
            took_lock = False
 
1695
        repo_token = self.repository.lock_write()
2370
1696
        try:
2371
 
            return BranchWriteLockResult(self.unlock,
2372
 
                self.control_files.lock_write(token=token))
 
1697
            token = self.control_files.lock_write(token=token)
2373
1698
        except:
2374
 
            if took_lock:
2375
 
                self.repository.unlock()
 
1699
            self.repository.unlock()
2376
1700
            raise
 
1701
        return token
2377
1702
 
2378
1703
    def lock_read(self):
2379
 
        """Lock the branch for read operations.
2380
 
 
2381
 
        :return: A bzrlib.lock.LogicalLockResult.
2382
 
        """
2383
 
        if not self.is_locked():
2384
 
            self._note_lock('r')
2385
 
        # All-in-one needs to always unlock/lock.
2386
 
        repo_control = getattr(self.repository, 'control_files', None)
2387
 
        if self.control_files == repo_control or not self.is_locked():
2388
 
            self.repository._warn_if_deprecated(self)
2389
 
            self.repository.lock_read()
2390
 
            took_lock = True
2391
 
        else:
2392
 
            took_lock = False
 
1704
        self.repository.lock_read()
2393
1705
        try:
2394
1706
            self.control_files.lock_read()
2395
 
            return LogicalLockResult(self.unlock)
2396
1707
        except:
2397
 
            if took_lock:
2398
 
                self.repository.unlock()
 
1708
            self.repository.unlock()
2399
1709
            raise
2400
1710
 
2401
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2402
1711
    def unlock(self):
 
1712
        # TODO: test for failed two phase locks. This is known broken.
2403
1713
        try:
2404
1714
            self.control_files.unlock()
2405
1715
        finally:
2406
 
            # All-in-one needs to always unlock/lock.
2407
 
            repo_control = getattr(self.repository, 'control_files', None)
2408
 
            if (self.control_files == repo_control or
2409
 
                not self.control_files.is_locked()):
2410
 
                self.repository.unlock()
2411
 
            if not self.control_files.is_locked():
2412
 
                # we just released the lock
2413
 
                self._clear_cached_state()
2414
 
 
 
1716
            self.repository.unlock()
 
1717
        if not self.control_files.is_locked():
 
1718
            # we just released the lock
 
1719
            self._clear_cached_state()
 
1720
        
2415
1721
    def peek_lock_mode(self):
2416
1722
        if self.control_files._lock_count == 0:
2417
1723
            return None
2489
1795
                new_history = rev.get_history(self.repository)[1:]
2490
1796
        destination.set_revision_history(new_history)
2491
1797
 
 
1798
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1799
        """Run the pre_change_branch_tip hooks."""
 
1800
        hooks = Branch.hooks['pre_change_branch_tip']
 
1801
        if not hooks:
 
1802
            return
 
1803
        old_revno, old_revid = self.last_revision_info()
 
1804
        params = ChangeBranchTipParams(
 
1805
            self, old_revno, new_revno, old_revid, new_revid)
 
1806
        for hook in hooks:
 
1807
            try:
 
1808
                hook(params)
 
1809
            except errors.TipChangeRejected:
 
1810
                raise
 
1811
            except Exception:
 
1812
                exc_info = sys.exc_info()
 
1813
                hook_name = Branch.hooks.get_hook_name(hook)
 
1814
                raise errors.HookFailed(
 
1815
                    'pre_change_branch_tip', hook_name, exc_info)
 
1816
 
 
1817
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1818
        """Run the post_change_branch_tip hooks."""
 
1819
        hooks = Branch.hooks['post_change_branch_tip']
 
1820
        if not hooks:
 
1821
            return
 
1822
        new_revno, new_revid = self.last_revision_info()
 
1823
        params = ChangeBranchTipParams(
 
1824
            self, old_revno, new_revno, old_revid, new_revid)
 
1825
        for hook in hooks:
 
1826
            hook(params)
 
1827
 
2492
1828
    @needs_write_lock
2493
1829
    def set_last_revision_info(self, revno, revision_id):
2494
1830
        """Set the last revision of this branch.
2497
1833
        for this revision id.
2498
1834
 
2499
1835
        It may be possible to set the branch last revision to an id not
2500
 
        present in the repository.  However, branches can also be
 
1836
        present in the repository.  However, branches can also be 
2501
1837
        configured to check constraints on history, in which case this may not
2502
1838
        be permitted.
2503
1839
        """
2517
1853
            history.pop()
2518
1854
        return history
2519
1855
 
 
1856
    def _lefthand_history(self, revision_id, last_rev=None,
 
1857
                          other_branch=None):
 
1858
        if 'evil' in debug.debug_flags:
 
1859
            mutter_callsite(4, "_lefthand_history scales with history.")
 
1860
        # stop_revision must be a descendant of last_revision
 
1861
        graph = self.repository.get_graph()
 
1862
        if last_rev is not None:
 
1863
            if not graph.is_ancestor(last_rev, revision_id):
 
1864
                # our previous tip is not merged into stop_revision
 
1865
                raise errors.DivergedBranches(self, other_branch)
 
1866
        # make a new revision history from the graph
 
1867
        parents_map = graph.get_parent_map([revision_id])
 
1868
        if revision_id not in parents_map:
 
1869
            raise errors.NoSuchRevision(self, revision_id)
 
1870
        current_rev_id = revision_id
 
1871
        new_history = []
 
1872
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
1873
        # Do not include ghosts or graph origin in revision_history
 
1874
        while (current_rev_id in parents_map and
 
1875
               len(parents_map[current_rev_id]) > 0):
 
1876
            check_not_reserved_id(current_rev_id)
 
1877
            new_history.append(current_rev_id)
 
1878
            current_rev_id = parents_map[current_rev_id][0]
 
1879
            parents_map = graph.get_parent_map([current_rev_id])
 
1880
        new_history.reverse()
 
1881
        return new_history
 
1882
 
2520
1883
    @needs_write_lock
2521
1884
    def generate_revision_history(self, revision_id, last_rev=None,
2522
1885
        other_branch=None):
2535
1898
        """See Branch.basis_tree."""
2536
1899
        return self.repository.revision_tree(self.last_revision())
2537
1900
 
 
1901
    @needs_write_lock
 
1902
    def pull(self, source, overwrite=False, stop_revision=None,
 
1903
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1904
             _override_hook_target=None):
 
1905
        """See Branch.pull.
 
1906
 
 
1907
        :param _hook_master: Private parameter - set the branch to 
 
1908
            be supplied as the master to pull hooks.
 
1909
        :param run_hooks: Private parameter - if false, this branch
 
1910
            is being called because it's the master of the primary branch,
 
1911
            so it should not run its hooks.
 
1912
        :param _override_hook_target: Private parameter - set the branch to be
 
1913
            supplied as the target_branch to pull hooks.
 
1914
        """
 
1915
        result = PullResult()
 
1916
        result.source_branch = source
 
1917
        if _override_hook_target is None:
 
1918
            result.target_branch = self
 
1919
        else:
 
1920
            result.target_branch = _override_hook_target
 
1921
        source.lock_read()
 
1922
        try:
 
1923
            # We assume that during 'pull' the local repository is closer than
 
1924
            # the remote one.
 
1925
            graph = self.repository.get_graph(source.repository)
 
1926
            result.old_revno, result.old_revid = self.last_revision_info()
 
1927
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1928
                                  graph=graph)
 
1929
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1930
            result.new_revno, result.new_revid = self.last_revision_info()
 
1931
            if _hook_master:
 
1932
                result.master_branch = _hook_master
 
1933
                result.local_branch = result.target_branch
 
1934
            else:
 
1935
                result.master_branch = result.target_branch
 
1936
                result.local_branch = None
 
1937
            if run_hooks:
 
1938
                for hook in Branch.hooks['post_pull']:
 
1939
                    hook(result)
 
1940
        finally:
 
1941
            source.unlock()
 
1942
        return result
 
1943
 
2538
1944
    def _get_parent_location(self):
2539
1945
        _locs = ['parent', 'pull', 'x-pull']
2540
1946
        for l in _locs:
2544
1950
                pass
2545
1951
        return None
2546
1952
 
 
1953
    @needs_read_lock
 
1954
    def push(self, target, overwrite=False, stop_revision=None,
 
1955
             _override_hook_source_branch=None):
 
1956
        """See Branch.push.
 
1957
 
 
1958
        This is the basic concrete implementation of push()
 
1959
 
 
1960
        :param _override_hook_source_branch: If specified, run
 
1961
        the hooks passing this Branch as the source, rather than self.  
 
1962
        This is for use of RemoteBranch, where push is delegated to the
 
1963
        underlying vfs-based Branch. 
 
1964
        """
 
1965
        # TODO: Public option to disable running hooks - should be trivial but
 
1966
        # needs tests.
 
1967
        return _run_with_write_locked_target(
 
1968
            target, self._push_with_bound_branches, target, overwrite,
 
1969
            stop_revision,
 
1970
            _override_hook_source_branch=_override_hook_source_branch)
 
1971
 
 
1972
    def _push_with_bound_branches(self, target, overwrite,
 
1973
            stop_revision,
 
1974
            _override_hook_source_branch=None):
 
1975
        """Push from self into target, and into target's master if any.
 
1976
        
 
1977
        This is on the base BzrBranch class even though it doesn't support 
 
1978
        bound branches because the *target* might be bound.
 
1979
        """
 
1980
        def _run_hooks():
 
1981
            if _override_hook_source_branch:
 
1982
                result.source_branch = _override_hook_source_branch
 
1983
            for hook in Branch.hooks['post_push']:
 
1984
                hook(result)
 
1985
 
 
1986
        bound_location = target.get_bound_location()
 
1987
        if bound_location and target.base != bound_location:
 
1988
            # there is a master branch.
 
1989
            #
 
1990
            # XXX: Why the second check?  Is it even supported for a branch to
 
1991
            # be bound to itself? -- mbp 20070507
 
1992
            master_branch = target.get_master_branch()
 
1993
            master_branch.lock_write()
 
1994
            try:
 
1995
                # push into the master from this branch.
 
1996
                self._basic_push(master_branch, overwrite, stop_revision)
 
1997
                # and push into the target branch from this. Note that we push from
 
1998
                # this branch again, because its considered the highest bandwidth
 
1999
                # repository.
 
2000
                result = self._basic_push(target, overwrite, stop_revision)
 
2001
                result.master_branch = master_branch
 
2002
                result.local_branch = target
 
2003
                _run_hooks()
 
2004
                return result
 
2005
            finally:
 
2006
                master_branch.unlock()
 
2007
        else:
 
2008
            # no master branch
 
2009
            result = self._basic_push(target, overwrite, stop_revision)
 
2010
            # TODO: Why set master_branch and local_branch if there's no
 
2011
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2012
            # 20070504
 
2013
            result.master_branch = target
 
2014
            result.local_branch = None
 
2015
            _run_hooks()
 
2016
            return result
 
2017
 
2547
2018
    def _basic_push(self, target, overwrite, stop_revision):
2548
2019
        """Basic implementation of push without bound branches or hooks.
2549
2020
 
2550
 
        Must be called with source read locked and target write locked.
 
2021
        Must be called with self read locked and target write locked.
2551
2022
        """
2552
 
        result = BranchPushResult()
 
2023
        result = PushResult()
2553
2024
        result.source_branch = self
2554
2025
        result.target_branch = target
2555
2026
        result.old_revno, result.old_revid = target.last_revision_info()
2556
 
        self.update_references(target)
2557
2027
        if result.old_revid != self.last_revision():
2558
2028
            # We assume that during 'push' this repository is closer than
2559
2029
            # the target.
2560
2030
            graph = self.repository.get_graph(target.repository)
2561
 
            target.update_revisions(self, stop_revision,
2562
 
                overwrite=overwrite, graph=graph)
 
2031
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2032
                                    graph=graph)
2563
2033
        if self._push_should_merge_tags():
2564
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2565
 
                overwrite)
 
2034
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2566
2035
        result.new_revno, result.new_revid = target.last_revision_info()
2567
2036
        return result
2568
2037
 
 
2038
    def _push_should_merge_tags(self):
 
2039
        """Should _basic_push merge this branch's tags into the target?
 
2040
        
 
2041
        The default implementation returns False if this branch has no tags,
 
2042
        and True the rest of the time.  Subclasses may override this.
 
2043
        """
 
2044
        return self.tags.supports_tags() and self.tags.get_tag_dict()
 
2045
 
 
2046
    def get_parent(self):
 
2047
        """See Branch.get_parent."""
 
2048
        parent = self._get_parent_location()
 
2049
        if parent is None:
 
2050
            return parent
 
2051
        # This is an old-format absolute path to a local branch
 
2052
        # turn it into a url
 
2053
        if parent.startswith('/'):
 
2054
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
2055
        try:
 
2056
            return urlutils.join(self.base[:-1], parent)
 
2057
        except errors.InvalidURLJoin, e:
 
2058
            raise errors.InaccessibleParent(parent, self.base)
 
2059
 
2569
2060
    def get_stacked_on_url(self):
2570
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2061
        raise errors.UnstackableBranchFormat(self._format, self.base)
2571
2062
 
2572
2063
    def set_push_location(self, location):
2573
2064
        """See Branch.set_push_location."""
2575
2066
            'push_location', location,
2576
2067
            store=_mod_config.STORE_LOCATION_NORECURSE)
2577
2068
 
 
2069
    @needs_write_lock
 
2070
    def set_parent(self, url):
 
2071
        """See Branch.set_parent."""
 
2072
        # TODO: Maybe delete old location files?
 
2073
        # URLs should never be unicode, even on the local fs,
 
2074
        # FIXUP this and get_parent in a future branch format bump:
 
2075
        # read and rewrite the file. RBC 20060125
 
2076
        if url is not None:
 
2077
            if isinstance(url, unicode):
 
2078
                try:
 
2079
                    url = url.encode('ascii')
 
2080
                except UnicodeEncodeError:
 
2081
                    raise errors.InvalidURL(url,
 
2082
                        "Urls must be 7-bit ascii, "
 
2083
                        "use bzrlib.urlutils.escape")
 
2084
            url = urlutils.relative_url(self.base, url)
 
2085
        self._set_parent_location(url)
 
2086
 
2578
2087
    def _set_parent_location(self, url):
2579
2088
        if url is None:
2580
2089
            self._transport.delete('parent')
2582
2091
            self._transport.put_bytes('parent', url + '\n',
2583
2092
                mode=self.bzrdir._get_file_mode())
2584
2093
 
 
2094
    def set_stacked_on_url(self, url):
 
2095
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2096
 
2585
2097
 
2586
2098
class BzrBranch5(BzrBranch):
2587
2099
    """A format 5 branch. This supports new features over plain branches.
2589
2101
    It has support for a master_branch which is the data for bound branches.
2590
2102
    """
2591
2103
 
 
2104
    @needs_write_lock
 
2105
    def pull(self, source, overwrite=False, stop_revision=None,
 
2106
             run_hooks=True, possible_transports=None,
 
2107
             _override_hook_target=None):
 
2108
        """Pull from source into self, updating my master if any.
 
2109
        
 
2110
        :param run_hooks: Private parameter - if false, this branch
 
2111
            is being called because it's the master of the primary branch,
 
2112
            so it should not run its hooks.
 
2113
        """
 
2114
        bound_location = self.get_bound_location()
 
2115
        master_branch = None
 
2116
        if bound_location and source.base != bound_location:
 
2117
            # not pulling from master, so we need to update master.
 
2118
            master_branch = self.get_master_branch(possible_transports)
 
2119
            master_branch.lock_write()
 
2120
        try:
 
2121
            if master_branch:
 
2122
                # pull from source into master.
 
2123
                master_branch.pull(source, overwrite, stop_revision,
 
2124
                    run_hooks=False)
 
2125
            return super(BzrBranch5, self).pull(source, overwrite,
 
2126
                stop_revision, _hook_master=master_branch,
 
2127
                run_hooks=run_hooks,
 
2128
                _override_hook_target=_override_hook_target)
 
2129
        finally:
 
2130
            if master_branch:
 
2131
                master_branch.unlock()
 
2132
 
2592
2133
    def get_bound_location(self):
2593
2134
        try:
2594
2135
            return self._transport.get_bytes('bound')[:-1]
2598
2139
    @needs_read_lock
2599
2140
    def get_master_branch(self, possible_transports=None):
2600
2141
        """Return the branch we are bound to.
2601
 
 
 
2142
        
2602
2143
        :return: Either a Branch, or None
2603
2144
 
2604
2145
        This could memoise the branch, but if thats done
2640
2181
        check for divergence to raise an error when the branches are not
2641
2182
        either the same, or one a prefix of the other. That behaviour may not
2642
2183
        be useful, so that check may be removed in future.
2643
 
 
 
2184
        
2644
2185
        :param other: The branch to bind to
2645
2186
        :type other: Branch
2646
2187
        """
2665
2206
 
2666
2207
    @needs_write_lock
2667
2208
    def update(self, possible_transports=None):
2668
 
        """Synchronise this branch with the master branch if any.
 
2209
        """Synchronise this branch with the master branch if any. 
2669
2210
 
2670
2211
        :return: None or the last_revision that was pivoted out during the
2671
2212
                 update.
2681
2222
        return None
2682
2223
 
2683
2224
 
2684
 
class BzrBranch8(BzrBranch5):
2685
 
    """A branch that stores tree-reference locations."""
 
2225
class BzrBranch7(BzrBranch5):
 
2226
    """A branch with support for a fallback repository."""
 
2227
 
 
2228
    def _get_fallback_repository(self, url):
 
2229
        """Get the repository we fallback to at url."""
 
2230
        url = urlutils.join(self.base, url)
 
2231
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2232
                                      possible_transports=[self._transport])
 
2233
        return a_bzrdir.open_branch().repository
 
2234
 
 
2235
    def _activate_fallback_location(self, url):
 
2236
        """Activate the branch/repository from url as a fallback repository."""
 
2237
        self.repository.add_fallback_repository(
 
2238
            self._get_fallback_repository(url))
2686
2239
 
2687
2240
    def _open_hook(self):
2688
 
        if self._ignore_fallbacks:
2689
 
            return
2690
2241
        try:
2691
2242
            url = self.get_stacked_on_url()
2692
2243
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2702
2253
                        "None, not a URL." % hook_name)
2703
2254
            self._activate_fallback_location(url)
2704
2255
 
 
2256
    def _check_stackable_repo(self):
 
2257
        if not self.repository._format.supports_external_lookups:
 
2258
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2259
                self.repository.base)
 
2260
 
2705
2261
    def __init__(self, *args, **kwargs):
2706
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2707
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2262
        super(BzrBranch7, self).__init__(*args, **kwargs)
2708
2263
        self._last_revision_info_cache = None
2709
 
        self._reference_info = None
 
2264
        self._partial_revision_history_cache = []
2710
2265
 
2711
2266
    def _clear_cached_state(self):
2712
 
        super(BzrBranch8, self)._clear_cached_state()
 
2267
        super(BzrBranch7, self)._clear_cached_state()
2713
2268
        self._last_revision_info_cache = None
2714
 
        self._reference_info = None
 
2269
        self._partial_revision_history_cache = []
2715
2270
 
2716
2271
    def _last_revision_info(self):
2717
2272
        revision_string = self._transport.get_bytes('last-revision')
2748
2303
 
2749
2304
    def _synchronize_history(self, destination, revision_id):
2750
2305
        """Synchronize last revision and revision history between branches.
2751
 
 
 
2306
        
2752
2307
        :see: Branch._synchronize_history
2753
2308
        """
2754
2309
        # XXX: The base Branch has a fast implementation of this method based
2763
2318
        if _mod_revision.is_null(last_revision):
2764
2319
            return
2765
2320
        if last_revision not in self._lefthand_history(revision_id):
2766
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2321
            raise errors.AppendRevisionsOnlyViolation(self.base)
2767
2322
 
2768
2323
    def _gen_revision_history(self):
2769
2324
        """Generate the revision history from last revision
2772
2327
        self._extend_partial_history(stop_index=last_revno-1)
2773
2328
        return list(reversed(self._partial_revision_history_cache))
2774
2329
 
 
2330
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2331
        """Extend the partial history to include a given index
 
2332
 
 
2333
        If a stop_index is supplied, stop when that index has been reached.
 
2334
        If a stop_revision is supplied, stop when that revision is
 
2335
        encountered.  Otherwise, stop when the beginning of history is
 
2336
        reached.
 
2337
 
 
2338
        :param stop_index: The index which should be present.  When it is
 
2339
            present, history extension will stop.
 
2340
        :param revision_id: The revision id which should be present.  When
 
2341
            it is encountered, history extension will stop.
 
2342
        """
 
2343
        repo = self.repository
 
2344
        if len(self._partial_revision_history_cache) == 0:
 
2345
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2346
        else:
 
2347
            start_revision = self._partial_revision_history_cache[-1]
 
2348
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2349
            #skip the last revision in the list
 
2350
            next_revision = iterator.next()
 
2351
        for revision_id in iterator:
 
2352
            self._partial_revision_history_cache.append(revision_id)
 
2353
            if (stop_index is not None and
 
2354
                len(self._partial_revision_history_cache) > stop_index):
 
2355
                break
 
2356
            if revision_id == stop_revision:
 
2357
                break
 
2358
 
2775
2359
    def _write_revision_history(self, history):
2776
2360
        """Factored out of set_revision_history.
2777
2361
 
2798
2382
        """Set the parent branch"""
2799
2383
        return self._get_config_location('parent_location')
2800
2384
 
2801
 
    @needs_write_lock
2802
 
    def _set_all_reference_info(self, info_dict):
2803
 
        """Replace all reference info stored in a branch.
2804
 
 
2805
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2806
 
        """
2807
 
        s = StringIO()
2808
 
        writer = rio.RioWriter(s)
2809
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2810
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2811
 
                                branch_location=branch_location)
2812
 
            writer.write_stanza(stanza)
2813
 
        self._transport.put_bytes('references', s.getvalue())
2814
 
        self._reference_info = info_dict
2815
 
 
2816
 
    @needs_read_lock
2817
 
    def _get_all_reference_info(self):
2818
 
        """Return all the reference info stored in a branch.
2819
 
 
2820
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2821
 
        """
2822
 
        if self._reference_info is not None:
2823
 
            return self._reference_info
2824
 
        rio_file = self._transport.get('references')
2825
 
        try:
2826
 
            stanzas = rio.read_stanzas(rio_file)
2827
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2828
 
                             s['branch_location'])) for s in stanzas)
2829
 
        finally:
2830
 
            rio_file.close()
2831
 
        self._reference_info = info_dict
2832
 
        return info_dict
2833
 
 
2834
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2835
 
        """Set the branch location to use for a tree reference.
2836
 
 
2837
 
        :param file_id: The file-id of the tree reference.
2838
 
        :param tree_path: The path of the tree reference in the tree.
2839
 
        :param branch_location: The location of the branch to retrieve tree
2840
 
            references from.
2841
 
        """
2842
 
        info_dict = self._get_all_reference_info()
2843
 
        info_dict[file_id] = (tree_path, branch_location)
2844
 
        if None in (tree_path, branch_location):
2845
 
            if tree_path is not None:
2846
 
                raise ValueError('tree_path must be None when branch_location'
2847
 
                                 ' is None.')
2848
 
            if branch_location is not None:
2849
 
                raise ValueError('branch_location must be None when tree_path'
2850
 
                                 ' is None.')
2851
 
            del info_dict[file_id]
2852
 
        self._set_all_reference_info(info_dict)
2853
 
 
2854
 
    def get_reference_info(self, file_id):
2855
 
        """Get the tree_path and branch_location for a tree reference.
2856
 
 
2857
 
        :return: a tuple of (tree_path, branch_location)
2858
 
        """
2859
 
        return self._get_all_reference_info().get(file_id, (None, None))
2860
 
 
2861
 
    def reference_parent(self, file_id, path, possible_transports=None):
2862
 
        """Return the parent branch for a tree-reference file_id.
2863
 
 
2864
 
        :param file_id: The file_id of the tree reference
2865
 
        :param path: The path of the file_id in the tree
2866
 
        :return: A branch associated with the file_id
2867
 
        """
2868
 
        branch_location = self.get_reference_info(file_id)[1]
2869
 
        if branch_location is None:
2870
 
            return Branch.reference_parent(self, file_id, path,
2871
 
                                           possible_transports)
2872
 
        branch_location = urlutils.join(self.user_url, branch_location)
2873
 
        return Branch.open(branch_location,
2874
 
                           possible_transports=possible_transports)
2875
 
 
2876
2385
    def set_push_location(self, location):
2877
2386
        """See Branch.set_push_location."""
2878
2387
        self._set_config_location('push_location', location)
2920
2429
            raise errors.NotStacked(self)
2921
2430
        return stacked_url
2922
2431
 
 
2432
    def set_append_revisions_only(self, enabled):
 
2433
        if enabled:
 
2434
            value = 'True'
 
2435
        else:
 
2436
            value = 'False'
 
2437
        self.get_config().set_user_option('append_revisions_only', value,
 
2438
            warn_masked=True)
 
2439
 
 
2440
    def set_stacked_on_url(self, url):
 
2441
        self._check_stackable_repo()
 
2442
        if not url:
 
2443
            try:
 
2444
                old_url = self.get_stacked_on_url()
 
2445
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2446
                errors.UnstackableRepositoryFormat):
 
2447
                return
 
2448
            url = ''
 
2449
            # repositories don't offer an interface to remove fallback
 
2450
            # repositories today; take the conceptually simpler option and just
 
2451
            # reopen it.
 
2452
            self.repository = self.bzrdir.find_repository()
 
2453
            # for every revision reference the branch has, ensure it is pulled
 
2454
            # in.
 
2455
            source_repository = self._get_fallback_repository(old_url)
 
2456
            for revision_id in chain([self.last_revision()],
 
2457
                self.tags.get_reverse_tag_dict()):
 
2458
                self.repository.fetch(source_repository, revision_id,
 
2459
                    find_ghosts=True)
 
2460
        else:
 
2461
            self._activate_fallback_location(url)
 
2462
        # write this out after the repository is stacked to avoid setting a
 
2463
        # stacked config that doesn't work.
 
2464
        self._set_config_location('stacked_on_location', url)
 
2465
 
2923
2466
    def _get_append_revisions_only(self):
2924
 
        return self.get_config(
2925
 
            ).get_user_option_as_bool('append_revisions_only')
 
2467
        value = self.get_config().get_user_option('append_revisions_only')
 
2468
        return value == 'True'
 
2469
 
 
2470
    def _make_tags(self):
 
2471
        return BasicTags(self)
2926
2472
 
2927
2473
    @needs_write_lock
2928
2474
    def generate_revision_history(self, revision_id, last_rev=None,
2968
2514
        return self.revno() - index
2969
2515
 
2970
2516
 
2971
 
class BzrBranch7(BzrBranch8):
2972
 
    """A branch with support for a fallback repository."""
2973
 
 
2974
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2975
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2976
 
 
2977
 
    def get_reference_info(self, file_id):
2978
 
        Branch.get_reference_info(self, file_id)
2979
 
 
2980
 
    def reference_parent(self, file_id, path, possible_transports=None):
2981
 
        return Branch.reference_parent(self, file_id, path,
2982
 
                                       possible_transports)
2983
 
 
2984
 
 
2985
2517
class BzrBranch6(BzrBranch7):
2986
2518
    """See BzrBranchFormat6 for the capabilities of this branch.
2987
2519
 
2990
2522
    """
2991
2523
 
2992
2524
    def get_stacked_on_url(self):
2993
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2525
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2526
 
 
2527
    def set_stacked_on_url(self, url):
 
2528
        raise errors.UnstackableBranchFormat(self._format, self.base)
2994
2529
 
2995
2530
 
2996
2531
######################################################################
3014
2549
    :ivar new_revno: Revision number after pull.
3015
2550
    :ivar old_revid: Tip revision id before pull.
3016
2551
    :ivar new_revid: Tip revision id after pull.
3017
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2552
    :ivar source_branch: Source (local) branch object.
3018
2553
    :ivar master_branch: Master branch of the target, or the target if no
3019
2554
        Master
3020
2555
    :ivar local_branch: target branch if there is a Master, else None
3021
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2556
    :ivar target_branch: Target/destination branch object.
3022
2557
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3023
2558
    """
3024
2559
 
3035
2570
        self._show_tag_conficts(to_file)
3036
2571
 
3037
2572
 
3038
 
class BranchPushResult(_Result):
 
2573
class PushResult(_Result):
3039
2574
    """Result of a Branch.push operation.
3040
2575
 
3041
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3042
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3043
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3044
 
        before the push.
3045
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3046
 
        after the push.
3047
 
    :ivar source_branch: Source branch object that the push was from. This is
3048
 
        read locked, and generally is a local (and thus low latency) branch.
3049
 
    :ivar master_branch: If target is a bound branch, the master branch of
3050
 
        target, or target itself. Always write locked.
3051
 
    :ivar target_branch: The direct Branch where data is being sent (write
3052
 
        locked).
3053
 
    :ivar local_branch: If the target is a bound branch this will be the
3054
 
        target, otherwise it will be None.
 
2576
    :ivar old_revno: Revision number before push.
 
2577
    :ivar new_revno: Revision number after push.
 
2578
    :ivar old_revid: Tip revision id before push.
 
2579
    :ivar new_revid: Tip revision id after push.
 
2580
    :ivar source_branch: Source branch object.
 
2581
    :ivar master_branch: Master branch of the target, or None.
 
2582
    :ivar target_branch: Target/destination branch object.
3055
2583
    """
3056
2584
 
3057
2585
    def __int__(self):
3061
2589
    def report(self, to_file):
3062
2590
        """Write a human-readable description of the result."""
3063
2591
        if self.old_revid == self.new_revid:
3064
 
            note('No new revisions to push.')
 
2592
            to_file.write('No new revisions to push.\n')
3065
2593
        else:
3066
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2594
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3067
2595
        self._show_tag_conficts(to_file)
3068
2596
 
3069
2597
 
3075
2603
 
3076
2604
    def __init__(self, branch):
3077
2605
        self.branch = branch
3078
 
        self.errors = []
3079
2606
 
3080
2607
    def report_results(self, verbose):
3081
2608
        """Report the check results via trace.note.
3082
 
 
 
2609
        
3083
2610
        :param verbose: Requests more detailed display of what was checked,
3084
2611
            if any.
3085
2612
        """
3086
 
        note('checked branch %s format %s', self.branch.user_url,
3087
 
            self.branch._format)
3088
 
        for error in self.errors:
3089
 
            note('found error:%s', error)
 
2613
        note('checked branch %s format %s',
 
2614
             self.branch.base,
 
2615
             self.branch._format)
3090
2616
 
3091
2617
 
3092
2618
class Converter5to6(object):
3130
2656
        branch._transport.put_bytes('format', format.get_format_string())
3131
2657
 
3132
2658
 
3133
 
class Converter7to8(object):
3134
 
    """Perform an in-place upgrade of format 6 to format 7"""
3135
 
 
3136
 
    def convert(self, branch):
3137
 
        format = BzrBranchFormat8()
3138
 
        branch._transport.put_bytes('references', '')
3139
 
        # update target format
3140
 
        branch._transport.put_bytes('format', format.get_format_string())
3141
 
 
3142
2659
 
3143
2660
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3144
2661
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3155
2672
            return callable(*args, **kwargs)
3156
2673
        finally:
3157
2674
            target.unlock()
3158
 
 
 
2675
    
3159
2676
    """
3160
2677
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3161
2678
    # should share code?
3171
2688
    else:
3172
2689
        target.unlock()
3173
2690
        return result
3174
 
 
3175
 
 
3176
 
class InterBranch(InterObject):
3177
 
    """This class represents operations taking place between two branches.
3178
 
 
3179
 
    Its instances have methods like pull() and push() and contain
3180
 
    references to the source and target repositories these operations
3181
 
    can be carried out on.
3182
 
    """
3183
 
 
3184
 
    _optimisers = []
3185
 
    """The available optimised InterBranch types."""
3186
 
 
3187
 
    @staticmethod
3188
 
    def _get_branch_formats_to_test():
3189
 
        """Return a tuple with the Branch formats to use when testing."""
3190
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3191
 
 
3192
 
    def pull(self, overwrite=False, stop_revision=None,
3193
 
             possible_transports=None, local=False):
3194
 
        """Mirror source into target branch.
3195
 
 
3196
 
        The target branch is considered to be 'local', having low latency.
3197
 
 
3198
 
        :returns: PullResult instance
3199
 
        """
3200
 
        raise NotImplementedError(self.pull)
3201
 
 
3202
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3203
 
                         graph=None):
3204
 
        """Pull in new perfect-fit revisions.
3205
 
 
3206
 
        :param stop_revision: Updated until the given revision
3207
 
        :param overwrite: Always set the branch pointer, rather than checking
3208
 
            to see if it is a proper descendant.
3209
 
        :param graph: A Graph object that can be used to query history
3210
 
            information. This can be None.
3211
 
        :return: None
3212
 
        """
3213
 
        raise NotImplementedError(self.update_revisions)
3214
 
 
3215
 
    def push(self, overwrite=False, stop_revision=None,
3216
 
             _override_hook_source_branch=None):
3217
 
        """Mirror the source branch into the target branch.
3218
 
 
3219
 
        The source branch is considered to be 'local', having low latency.
3220
 
        """
3221
 
        raise NotImplementedError(self.push)
3222
 
 
3223
 
 
3224
 
class GenericInterBranch(InterBranch):
3225
 
    """InterBranch implementation that uses public Branch functions.
3226
 
    """
3227
 
 
3228
 
    @staticmethod
3229
 
    def _get_branch_formats_to_test():
3230
 
        return BranchFormat._default_format, BranchFormat._default_format
3231
 
 
3232
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3233
 
        graph=None):
3234
 
        """See InterBranch.update_revisions()."""
3235
 
        self.source.lock_read()
3236
 
        try:
3237
 
            other_revno, other_last_revision = self.source.last_revision_info()
3238
 
            stop_revno = None # unknown
3239
 
            if stop_revision is None:
3240
 
                stop_revision = other_last_revision
3241
 
                if _mod_revision.is_null(stop_revision):
3242
 
                    # if there are no commits, we're done.
3243
 
                    return
3244
 
                stop_revno = other_revno
3245
 
 
3246
 
            # what's the current last revision, before we fetch [and change it
3247
 
            # possibly]
3248
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3249
 
            # we fetch here so that we don't process data twice in the common
3250
 
            # case of having something to pull, and so that the check for
3251
 
            # already merged can operate on the just fetched graph, which will
3252
 
            # be cached in memory.
3253
 
            self.target.fetch(self.source, stop_revision)
3254
 
            # Check to see if one is an ancestor of the other
3255
 
            if not overwrite:
3256
 
                if graph is None:
3257
 
                    graph = self.target.repository.get_graph()
3258
 
                if self.target._check_if_descendant_or_diverged(
3259
 
                        stop_revision, last_rev, graph, self.source):
3260
 
                    # stop_revision is a descendant of last_rev, but we aren't
3261
 
                    # overwriting, so we're done.
3262
 
                    return
3263
 
            if stop_revno is None:
3264
 
                if graph is None:
3265
 
                    graph = self.target.repository.get_graph()
3266
 
                this_revno, this_last_revision = \
3267
 
                        self.target.last_revision_info()
3268
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3269
 
                                [(other_last_revision, other_revno),
3270
 
                                 (this_last_revision, this_revno)])
3271
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3272
 
        finally:
3273
 
            self.source.unlock()
3274
 
 
3275
 
    def pull(self, overwrite=False, stop_revision=None,
3276
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3277
 
             _override_hook_target=None, local=False):
3278
 
        """See Branch.pull.
3279
 
 
3280
 
        :param _hook_master: Private parameter - set the branch to
3281
 
            be supplied as the master to pull hooks.
3282
 
        :param run_hooks: Private parameter - if false, this branch
3283
 
            is being called because it's the master of the primary branch,
3284
 
            so it should not run its hooks.
3285
 
        :param _override_hook_target: Private parameter - set the branch to be
3286
 
            supplied as the target_branch to pull hooks.
3287
 
        :param local: Only update the local branch, and not the bound branch.
3288
 
        """
3289
 
        # This type of branch can't be bound.
3290
 
        if local:
3291
 
            raise errors.LocalRequiresBoundBranch()
3292
 
        result = PullResult()
3293
 
        result.source_branch = self.source
3294
 
        if _override_hook_target is None:
3295
 
            result.target_branch = self.target
3296
 
        else:
3297
 
            result.target_branch = _override_hook_target
3298
 
        self.source.lock_read()
3299
 
        try:
3300
 
            # We assume that during 'pull' the target repository is closer than
3301
 
            # the source one.
3302
 
            self.source.update_references(self.target)
3303
 
            graph = self.target.repository.get_graph(self.source.repository)
3304
 
            # TODO: Branch formats should have a flag that indicates 
3305
 
            # that revno's are expensive, and pull() should honor that flag.
3306
 
            # -- JRV20090506
3307
 
            result.old_revno, result.old_revid = \
3308
 
                self.target.last_revision_info()
3309
 
            self.target.update_revisions(self.source, stop_revision,
3310
 
                overwrite=overwrite, graph=graph)
3311
 
            # TODO: The old revid should be specified when merging tags, 
3312
 
            # so a tags implementation that versions tags can only 
3313
 
            # pull in the most recent changes. -- JRV20090506
3314
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3315
 
                overwrite)
3316
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3317
 
            if _hook_master:
3318
 
                result.master_branch = _hook_master
3319
 
                result.local_branch = result.target_branch
3320
 
            else:
3321
 
                result.master_branch = result.target_branch
3322
 
                result.local_branch = None
3323
 
            if run_hooks:
3324
 
                for hook in Branch.hooks['post_pull']:
3325
 
                    hook(result)
3326
 
        finally:
3327
 
            self.source.unlock()
3328
 
        return result
3329
 
 
3330
 
    def push(self, overwrite=False, stop_revision=None,
3331
 
             _override_hook_source_branch=None):
3332
 
        """See InterBranch.push.
3333
 
 
3334
 
        This is the basic concrete implementation of push()
3335
 
 
3336
 
        :param _override_hook_source_branch: If specified, run
3337
 
        the hooks passing this Branch as the source, rather than self.
3338
 
        This is for use of RemoteBranch, where push is delegated to the
3339
 
        underlying vfs-based Branch.
3340
 
        """
3341
 
        # TODO: Public option to disable running hooks - should be trivial but
3342
 
        # needs tests.
3343
 
        self.source.lock_read()
3344
 
        try:
3345
 
            return _run_with_write_locked_target(
3346
 
                self.target, self._push_with_bound_branches, overwrite,
3347
 
                stop_revision,
3348
 
                _override_hook_source_branch=_override_hook_source_branch)
3349
 
        finally:
3350
 
            self.source.unlock()
3351
 
 
3352
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3353
 
            _override_hook_source_branch=None):
3354
 
        """Push from source into target, and into target's master if any.
3355
 
        """
3356
 
        def _run_hooks():
3357
 
            if _override_hook_source_branch:
3358
 
                result.source_branch = _override_hook_source_branch
3359
 
            for hook in Branch.hooks['post_push']:
3360
 
                hook(result)
3361
 
 
3362
 
        bound_location = self.target.get_bound_location()
3363
 
        if bound_location and self.target.base != bound_location:
3364
 
            # there is a master branch.
3365
 
            #
3366
 
            # XXX: Why the second check?  Is it even supported for a branch to
3367
 
            # be bound to itself? -- mbp 20070507
3368
 
            master_branch = self.target.get_master_branch()
3369
 
            master_branch.lock_write()
3370
 
            try:
3371
 
                # push into the master from the source branch.
3372
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3373
 
                # and push into the target branch from the source. Note that we
3374
 
                # push from the source branch again, because its considered the
3375
 
                # highest bandwidth repository.
3376
 
                result = self.source._basic_push(self.target, overwrite,
3377
 
                    stop_revision)
3378
 
                result.master_branch = master_branch
3379
 
                result.local_branch = self.target
3380
 
                _run_hooks()
3381
 
                return result
3382
 
            finally:
3383
 
                master_branch.unlock()
3384
 
        else:
3385
 
            # no master branch
3386
 
            result = self.source._basic_push(self.target, overwrite,
3387
 
                stop_revision)
3388
 
            # TODO: Why set master_branch and local_branch if there's no
3389
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3390
 
            # 20070504
3391
 
            result.master_branch = self.target
3392
 
            result.local_branch = None
3393
 
            _run_hooks()
3394
 
            return result
3395
 
 
3396
 
    @classmethod
3397
 
    def is_compatible(self, source, target):
3398
 
        # GenericBranch uses the public API, so always compatible
3399
 
        return True
3400
 
 
3401
 
 
3402
 
class InterToBranch5(GenericInterBranch):
3403
 
 
3404
 
    @staticmethod
3405
 
    def _get_branch_formats_to_test():
3406
 
        return BranchFormat._default_format, BzrBranchFormat5()
3407
 
 
3408
 
    def pull(self, overwrite=False, stop_revision=None,
3409
 
             possible_transports=None, run_hooks=True,
3410
 
             _override_hook_target=None, local=False):
3411
 
        """Pull from source into self, updating my master if any.
3412
 
 
3413
 
        :param run_hooks: Private parameter - if false, this branch
3414
 
            is being called because it's the master of the primary branch,
3415
 
            so it should not run its hooks.
3416
 
        """
3417
 
        bound_location = self.target.get_bound_location()
3418
 
        if local and not bound_location:
3419
 
            raise errors.LocalRequiresBoundBranch()
3420
 
        master_branch = None
3421
 
        if not local and bound_location and self.source.user_url != bound_location:
3422
 
            # not pulling from master, so we need to update master.
3423
 
            master_branch = self.target.get_master_branch(possible_transports)
3424
 
            master_branch.lock_write()
3425
 
        try:
3426
 
            if master_branch:
3427
 
                # pull from source into master.
3428
 
                master_branch.pull(self.source, overwrite, stop_revision,
3429
 
                    run_hooks=False)
3430
 
            return super(InterToBranch5, self).pull(overwrite,
3431
 
                stop_revision, _hook_master=master_branch,
3432
 
                run_hooks=run_hooks,
3433
 
                _override_hook_target=_override_hook_target)
3434
 
        finally:
3435
 
            if master_branch:
3436
 
                master_branch.unlock()
3437
 
 
3438
 
 
3439
 
InterBranch.register_optimiser(GenericInterBranch)
3440
 
InterBranch.register_optimiser(InterToBranch5)