~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2008-06-30 19:23:37 UTC
  • mto: This revision was merged to the branch mainline in revision 3543.
  • Revision ID: aaron@aaronbentley.com-20080630192337-3btwipid5vm0mty9
Test for correct conflicts on delete + change

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