/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: Canonical.com Patch Queue Manager
  • Date: 2008-07-17 09:40:51 UTC
  • mfrom: (3518.1.2 virtualvf)
  • Revision ID: pqm@pqm.ubuntu.com-20080717094051-cgyo1zagozwcd4mm
(Jelmer) Add VirtualVersionedFiles class.

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