~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-07-18 03:07:07 UTC
  • mfrom: (3535.5.1 lean_imports)
  • Revision ID: pqm@pqm.ubuntu.com-20080718030707-qimx9fv1d4xhlk1m
(jam) Some small import cleanups, to reduce unused dependencies.

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