/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2008-07-08 15:58:12 UTC
  • mfrom: (3353.1.4 paramiko-1.7.2-compat)
  • mto: This revision was merged to the branch mainline in revision 3531.
  • Revision ID: jelmer@samba.org-20080708155812-gacwrgs7d7n48a0d
Merge bashprompt script that prints the bzr branch nick.

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
 
        if revision_id is None:
1360
 
            revision_id = self.last_revision()
1361
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1362
 
            revision_id=revision_id, stacked_on=stacked_on,
1363
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1364
 
        return dir_to.open_branch()
1365
 
 
1366
791
    def create_checkout(self, to_location, revision_id=None,
1367
792
                        lightweight=False, accelerator_tree=None,
1368
793
                        hardlink=False):
1369
794
        """Create a checkout of a branch.
1370
 
 
 
795
        
1371
796
        :param to_location: The url to produce the checkout at
1372
797
        :param revision_id: The revision to check out
1373
798
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1385
810
        if lightweight:
1386
811
            format = self._get_checkout_format()
1387
812
            checkout = format.initialize_on_transport(t)
1388
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1389
 
                target_branch=self)
 
813
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1390
814
        else:
1391
815
            format = self._get_checkout_format()
1392
816
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1393
817
                to_location, force_new_tree=False, format=format)
1394
818
            checkout = checkout_branch.bzrdir
1395
819
            checkout_branch.bind(self)
1396
 
            # pull up to the specified revision_id to set the initial
 
820
            # pull up to the specified revision_id to set the initial 
1397
821
            # branch tip correctly, and seed it with history.
1398
822
            checkout_branch.pull(self, stop_revision=revision_id)
1399
823
            from_branch=None
1421
845
        reconciler.reconcile()
1422
846
        return reconciler
1423
847
 
1424
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
848
    def reference_parent(self, file_id, path):
1425
849
        """Return the parent branch for a tree-reference file_id
1426
850
        :param file_id: The file_id of the tree reference
1427
851
        :param path: The path of the file_id in the tree
1428
852
        :return: A branch associated with the file_id
1429
853
        """
1430
854
        # FIXME should provide multiple branches, based on config
1431
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1432
 
                           possible_transports=possible_transports)
 
855
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1433
856
 
1434
857
    def supports_tags(self):
1435
858
        return self._format.supports_tags()
1436
859
 
1437
 
    def automatic_tag_name(self, revision_id):
1438
 
        """Try to automatically find the tag name for a revision.
1439
 
 
1440
 
        :param revision_id: Revision id of the revision.
1441
 
        :return: A tag name or None if no tag name could be determined.
1442
 
        """
1443
 
        for hook in Branch.hooks['automatic_tag_name']:
1444
 
            ret = hook(self, revision_id)
1445
 
            if ret is not None:
1446
 
                return ret
1447
 
        return None
1448
 
 
1449
860
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1450
861
                                         other_branch):
1451
862
        """Ensure that revision_b is a descendant of revision_a.
1452
863
 
1453
864
        This is a helper function for update_revisions.
1454
 
 
 
865
        
1455
866
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1456
867
        :returns: True if revision_b is a descendant of revision_a.
1457
868
        """
1463
874
        elif relation == 'a_descends_from_b':
1464
875
            return False
1465
876
        else:
1466
 
            raise AssertionError("invalid relation: %r" % (relation,))
 
877
            raise AssertionError("invalid heads: %r" % heads)
1467
878
 
1468
879
    def _revision_relations(self, revision_a, revision_b, graph):
1469
880
        """Determine the relationship between two revisions.
1470
 
 
 
881
        
1471
882
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1472
883
        """
1473
884
        heads = graph.heads([revision_a, revision_b])
1479
890
        elif heads == set([revision_a]):
1480
891
            return 'a_descends_from_b'
1481
892
        else:
1482
 
            raise AssertionError("invalid heads: %r" % (heads,))
 
893
            raise AssertionError("invalid heads: %r" % heads)
1483
894
 
1484
895
 
1485
896
class BranchFormat(object):
1490
901
     * a format string,
1491
902
     * an open routine.
1492
903
 
1493
 
    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 
1494
905
    during branch opening. Its not required that these be instances, they
1495
 
    can be classes themselves with class methods - it simply depends on
 
906
    can be classes themselves with class methods - it simply depends on 
1496
907
    whether state is needed for a given format or not.
1497
908
 
1498
909
    Once a format is deprecated, just deprecate the initialize and open
1499
 
    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 
1500
911
    object will be created every time regardless.
1501
912
    """
1502
913
 
1506
917
    _formats = {}
1507
918
    """The known formats."""
1508
919
 
1509
 
    can_set_append_revisions_only = True
1510
 
 
1511
920
    def __eq__(self, other):
1512
921
        return self.__class__ is other.__class__
1513
922
 
1515
924
        return not (self == other)
1516
925
 
1517
926
    @classmethod
1518
 
    def find_format(klass, a_bzrdir, name=None):
 
927
    def find_format(klass, a_bzrdir):
1519
928
        """Return the format for the branch object in a_bzrdir."""
1520
929
        try:
1521
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1522
 
            format_string = transport.get_bytes("format")
 
930
            transport = a_bzrdir.get_branch_transport(None)
 
931
            format_string = transport.get("format").read()
1523
932
            return klass._formats[format_string]
1524
933
        except errors.NoSuchFile:
1525
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
934
            raise errors.NotBranchError(path=transport.base)
1526
935
        except KeyError:
1527
936
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1528
937
 
1564
973
        """Return the short format description for this format."""
1565
974
        raise NotImplementedError(self.get_format_description)
1566
975
 
1567
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1568
 
        hooks = Branch.hooks['post_branch_init']
1569
 
        if not hooks:
1570
 
            return
1571
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1572
 
        for hook in hooks:
1573
 
            hook(params)
1574
 
 
1575
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1576
 
                           lock_type='metadir', set_format=True):
 
976
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
977
                           set_format=True):
1577
978
        """Initialize a branch in a bzrdir, with specified files
1578
979
 
1579
980
        :param a_bzrdir: The bzrdir to initialize the branch in
1580
981
        :param utf8_files: The files to create as a list of
1581
982
            (filename, content) tuples
1582
 
        :param name: Name of colocated branch to create, if any
1583
983
        :param set_format: If True, set the format with
1584
984
            self.get_format_string.  (BzrBranch4 has its format set
1585
985
            elsewhere)
1586
986
        :return: a branch in this format
1587
987
        """
1588
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1589
 
        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)
1590
990
        lock_map = {
1591
991
            'metadir': ('lock', lockdir.LockDir),
1592
992
            'branch4': ('branch-lock', lockable_files.TransportLock),
1595
995
        control_files = lockable_files.LockableFiles(branch_transport,
1596
996
            lock_name, lock_class)
1597
997
        control_files.create_lock()
1598
 
        try:
1599
 
            control_files.lock_write()
1600
 
        except errors.LockContention:
1601
 
            if lock_type != 'branch4':
1602
 
                raise
1603
 
            lock_taken = False
1604
 
        else:
1605
 
            lock_taken = True
 
998
        control_files.lock_write()
1606
999
        if set_format:
1607
1000
            utf8_files += [('format', self.get_format_string())]
1608
1001
        try:
1611
1004
                    filename, content,
1612
1005
                    mode=a_bzrdir._get_file_mode())
1613
1006
        finally:
1614
 
            if lock_taken:
1615
 
                control_files.unlock()
1616
 
        branch = self.open(a_bzrdir, name, _found=True)
1617
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1618
 
        return branch
 
1007
            control_files.unlock()
 
1008
        return self.open(a_bzrdir, _found=True)
1619
1009
 
1620
 
    def initialize(self, a_bzrdir, name=None):
1621
 
        """Create a branch of this format in a_bzrdir.
1622
 
        
1623
 
        :param name: Name of the colocated branch to create.
1624
 
        """
 
1010
    def initialize(self, a_bzrdir):
 
1011
        """Create a branch of this format in a_bzrdir."""
1625
1012
        raise NotImplementedError(self.initialize)
1626
1013
 
1627
1014
    def is_supported(self):
1628
1015
        """Is this format supported?
1629
1016
 
1630
1017
        Supported formats can be initialized and opened.
1631
 
        Unsupported formats may not support initialization or committing or
 
1018
        Unsupported formats may not support initialization or committing or 
1632
1019
        some other features depending on the reason for not being supported.
1633
1020
        """
1634
1021
        return True
1635
1022
 
1636
 
    def make_tags(self, branch):
1637
 
        """Create a tags object for branch.
1638
 
 
1639
 
        This method is on BranchFormat, because BranchFormats are reflected
1640
 
        over the wire via network_name(), whereas full Branch instances require
1641
 
        multiple VFS method calls to operate at all.
1642
 
 
1643
 
        The default implementation returns a disabled-tags instance.
1644
 
 
1645
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1646
 
        on a RemoteBranch.
1647
 
        """
1648
 
        return DisabledTags(branch)
1649
 
 
1650
 
    def network_name(self):
1651
 
        """A simple byte string uniquely identifying this format for RPC calls.
1652
 
 
1653
 
        MetaDir branch formats use their disk format string to identify the
1654
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1655
 
        foreign formats like svn/git and hg should use some marker which is
1656
 
        unique and immutable.
1657
 
        """
1658
 
        raise NotImplementedError(self.network_name)
1659
 
 
1660
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1023
    def open(self, a_bzrdir, _found=False):
1661
1024
        """Return the branch object for a_bzrdir
1662
1025
 
1663
 
        :param a_bzrdir: A BzrDir that contains a branch.
1664
 
        :param name: Name of colocated branch to open
1665
 
        :param _found: a private parameter, do not use it. It is used to
1666
 
            indicate if format probing has already be done.
1667
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1668
 
            (if there are any).  Default is to open fallbacks.
 
1026
        _found is a private parameter, do not use it. It is used to indicate
 
1027
               if format probing has already be done.
1669
1028
        """
1670
1029
        raise NotImplementedError(self.open)
1671
1030
 
1672
1031
    @classmethod
1673
1032
    def register_format(klass, format):
1674
 
        """Register a metadir format."""
1675
1033
        klass._formats[format.get_format_string()] = format
1676
 
        # Metadir formats have a network name of their format string, and get
1677
 
        # registered as class factories.
1678
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1679
1034
 
1680
1035
    @classmethod
1681
1036
    def set_default_format(klass, format):
1682
1037
        klass._default_format = format
1683
1038
 
1684
 
    def supports_set_append_revisions_only(self):
1685
 
        """True if this format supports set_append_revisions_only."""
1686
 
        return False
1687
 
 
1688
 
    def supports_stacking(self):
1689
 
        """True if this format records a stacked-on branch."""
1690
 
        return False
1691
 
 
1692
1039
    @classmethod
1693
1040
    def unregister_format(klass, format):
1694
1041
        del klass._formats[format.get_format_string()]
1695
1042
 
1696
1043
    def __str__(self):
1697
 
        return self.get_format_description().rstrip()
 
1044
        return self.get_format_string().rstrip()
1698
1045
 
1699
1046
    def supports_tags(self):
1700
1047
        """True if this format supports tags stored in the branch"""
1703
1050
 
1704
1051
class BranchHooks(Hooks):
1705
1052
    """A dictionary mapping hook name to a list of callables for branch hooks.
1706
 
 
 
1053
    
1707
1054
    e.g. ['set_rh'] Is the list of items to be called when the
1708
1055
    set_revision_history function is invoked.
1709
1056
    """
1715
1062
        notified.
1716
1063
        """
1717
1064
        Hooks.__init__(self)
1718
 
        self.create_hook(HookPoint('set_rh',
1719
 
            "Invoked whenever the revision history has been set via "
1720
 
            "set_revision_history. The api signature is (branch, "
1721
 
            "revision_history), and the branch will be write-locked. "
1722
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1723
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1724
 
        self.create_hook(HookPoint('open',
1725
 
            "Called with the Branch object that has been opened after a "
1726
 
            "branch is opened.", (1, 8), None))
1727
 
        self.create_hook(HookPoint('post_push',
1728
 
            "Called after a push operation completes. post_push is called "
1729
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1730
 
            "bzr client.", (0, 15), None))
1731
 
        self.create_hook(HookPoint('post_pull',
1732
 
            "Called after a pull operation completes. post_pull is called "
1733
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1734
 
            "bzr client.", (0, 15), None))
1735
 
        self.create_hook(HookPoint('pre_commit',
1736
 
            "Called after a commit is calculated but before it is is "
1737
 
            "completed. pre_commit is called with (local, master, old_revno, "
1738
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1739
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1740
 
            "tree_delta is a TreeDelta object describing changes from the "
1741
 
            "basis revision. hooks MUST NOT modify this delta. "
1742
 
            " future_tree is an in-memory tree obtained from "
1743
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1744
 
            "tree.", (0,91), None))
1745
 
        self.create_hook(HookPoint('post_commit',
1746
 
            "Called in the bzr client after a commit has completed. "
1747
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1748
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1749
 
            "commit to a branch.", (0, 15), None))
1750
 
        self.create_hook(HookPoint('post_uncommit',
1751
 
            "Called in the bzr client after an uncommit completes. "
1752
 
            "post_uncommit is called with (local, master, old_revno, "
1753
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1754
 
            "or None, master is the target branch, and an empty branch "
1755
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1756
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1757
 
            "Called in bzr client and server before a change to the tip of a "
1758
 
            "branch is made. pre_change_branch_tip is called with a "
1759
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1760
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1761
 
        self.create_hook(HookPoint('post_change_branch_tip',
1762
 
            "Called in bzr client and server after a change to the tip of a "
1763
 
            "branch is made. post_change_branch_tip is called with a "
1764
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1765
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1766
 
        self.create_hook(HookPoint('transform_fallback_location',
1767
 
            "Called when a stacked branch is activating its fallback "
1768
 
            "locations. transform_fallback_location is called with (branch, "
1769
 
            "url), and should return a new url. Returning the same url "
1770
 
            "allows it to be used as-is, returning a different one can be "
1771
 
            "used to cause the branch to stack on a closer copy of that "
1772
 
            "fallback_location. Note that the branch cannot have history "
1773
 
            "accessing methods called on it during this hook because the "
1774
 
            "fallback locations have not been activated. When there are "
1775
 
            "multiple hooks installed for transform_fallback_location, "
1776
 
            "all are called with the url returned from the previous hook."
1777
 
            "The order is however undefined.", (1, 9), None))
1778
 
        self.create_hook(HookPoint('automatic_tag_name',
1779
 
            "Called to determine an automatic tag name for a revision."
1780
 
            "automatic_tag_name is called with (branch, revision_id) and "
1781
 
            "should return a tag name or None if no tag name could be "
1782
 
            "determined. The first non-None tag name returned will be used.",
1783
 
            (2, 2), None))
1784
 
        self.create_hook(HookPoint('post_branch_init',
1785
 
            "Called after new branch initialization completes. "
1786
 
            "post_branch_init is called with a "
1787
 
            "bzrlib.branch.BranchInitHookParams. "
1788
 
            "Note that init, branch and checkout (both heavyweight and "
1789
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1790
 
        self.create_hook(HookPoint('post_switch',
1791
 
            "Called after a checkout switches branch. "
1792
 
            "post_switch is called with a "
1793
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1794
 
 
 
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.6
 
1113
        # Invoked before 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['pre_change_branch_tip'] = []
 
1118
        # Introduced in 1.4
 
1119
        # Invoked after the tip of a branch changes.
 
1120
        # the api signature is
 
1121
        # (params) where params is a ChangeBranchTipParams with the members
 
1122
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1123
        self['post_change_branch_tip'] = []
1795
1124
 
1796
1125
 
1797
1126
# install the default hooks into the Branch class.
1829
1158
 
1830
1159
    def __eq__(self, other):
1831
1160
        return self.__dict__ == other.__dict__
1832
 
 
 
1161
    
1833
1162
    def __repr__(self):
1834
1163
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1835
 
            self.__class__.__name__, self.branch,
 
1164
            self.__class__.__name__, self.branch, 
1836
1165
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1837
1166
 
1838
1167
 
1839
 
class BranchInitHookParams(object):
1840
 
    """Object holding parameters passed to *_branch_init hooks.
1841
 
 
1842
 
    There are 4 fields that hooks may wish to access:
1843
 
 
1844
 
    :ivar format: the branch format
1845
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
 
    :ivar name: name of colocated branch, if any (or None)
1847
 
    :ivar branch: the branch created
1848
 
 
1849
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
 
    the checkout, hence they are different from the corresponding fields in
1851
 
    branch, which refer to the original branch.
1852
 
    """
1853
 
 
1854
 
    def __init__(self, format, a_bzrdir, name, branch):
1855
 
        """Create a group of BranchInitHook parameters.
1856
 
 
1857
 
        :param format: the branch format
1858
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1859
 
            initialized
1860
 
        :param name: name of colocated branch, if any (or None)
1861
 
        :param branch: the branch created
1862
 
 
1863
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1864
 
        to the checkout, hence they are different from the corresponding fields
1865
 
        in branch, which refer to the original branch.
1866
 
        """
1867
 
        self.format = format
1868
 
        self.bzrdir = a_bzrdir
1869
 
        self.name = name
1870
 
        self.branch = branch
1871
 
 
1872
 
    def __eq__(self, other):
1873
 
        return self.__dict__ == other.__dict__
1874
 
 
1875
 
    def __repr__(self):
1876
 
        if self.branch:
1877
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1878
 
        else:
1879
 
            return "<%s of format:%s bzrdir:%s>" % (
1880
 
                self.__class__.__name__, self.branch,
1881
 
                self.format, self.bzrdir)
1882
 
 
1883
 
 
1884
 
class SwitchHookParams(object):
1885
 
    """Object holding parameters passed to *_switch hooks.
1886
 
 
1887
 
    There are 4 fields that hooks may wish to access:
1888
 
 
1889
 
    :ivar control_dir: BzrDir of the checkout to change
1890
 
    :ivar to_branch: branch that the checkout is to reference
1891
 
    :ivar force: skip the check for local commits in a heavy checkout
1892
 
    :ivar revision_id: revision ID to switch to (or None)
1893
 
    """
1894
 
 
1895
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1896
 
        """Create a group of SwitchHook parameters.
1897
 
 
1898
 
        :param control_dir: BzrDir of the checkout to change
1899
 
        :param to_branch: branch that the checkout is to reference
1900
 
        :param force: skip the check for local commits in a heavy checkout
1901
 
        :param revision_id: revision ID to switch to (or None)
1902
 
        """
1903
 
        self.control_dir = control_dir
1904
 
        self.to_branch = to_branch
1905
 
        self.force = force
1906
 
        self.revision_id = revision_id
1907
 
 
1908
 
    def __eq__(self, other):
1909
 
        return self.__dict__ == other.__dict__
1910
 
 
1911
 
    def __repr__(self):
1912
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
 
            self.control_dir, self.to_branch,
1914
 
            self.revision_id)
1915
 
 
1916
 
 
1917
1168
class BzrBranchFormat4(BranchFormat):
1918
1169
    """Bzr branch format 4.
1919
1170
 
1926
1177
        """See BranchFormat.get_format_description()."""
1927
1178
        return "Branch format 4"
1928
1179
 
1929
 
    def initialize(self, a_bzrdir, name=None):
 
1180
    def initialize(self, a_bzrdir):
1930
1181
        """Create a branch of this format in a_bzrdir."""
1931
1182
        utf8_files = [('revision-history', ''),
1932
1183
                      ('branch-name', ''),
1933
1184
                      ]
1934
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1185
        return self._initialize_helper(a_bzrdir, utf8_files,
1935
1186
                                       lock_type='branch4', set_format=False)
1936
1187
 
1937
1188
    def __init__(self):
1938
1189
        super(BzrBranchFormat4, self).__init__()
1939
1190
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1940
1191
 
1941
 
    def network_name(self):
1942
 
        """The network name for this format is the control dirs disk label."""
1943
 
        return self._matchingbzrdir.get_format_string()
 
1192
    def open(self, a_bzrdir, _found=False):
 
1193
        """Return the branch object for a_bzrdir
1944
1194
 
1945
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1946
 
        """See BranchFormat.open()."""
 
1195
        _found is a private parameter, do not use it. It is used to indicate
 
1196
               if format probing has already be done.
 
1197
        """
1947
1198
        if not _found:
1948
1199
            # we are being called directly and must probe.
1949
1200
            raise NotImplementedError
1950
1201
        return BzrBranch(_format=self,
1951
1202
                         _control_files=a_bzrdir._control_files,
1952
1203
                         a_bzrdir=a_bzrdir,
1953
 
                         name=name,
1954
1204
                         _repository=a_bzrdir.open_repository())
1955
1205
 
1956
1206
    def __str__(self):
1957
1207
        return "Bazaar-NG branch format 4"
1958
1208
 
1959
1209
 
1960
 
class BranchFormatMetadir(BranchFormat):
1961
 
    """Common logic for meta-dir based branch formats."""
1962
 
 
1963
 
    def _branch_class(self):
1964
 
        """What class to instantiate on open calls."""
1965
 
        raise NotImplementedError(self._branch_class)
1966
 
 
1967
 
    def network_name(self):
1968
 
        """A simple byte string uniquely identifying this format for RPC calls.
1969
 
 
1970
 
        Metadir branch formats use their format string.
1971
 
        """
1972
 
        return self.get_format_string()
1973
 
 
1974
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1975
 
        """See BranchFormat.open()."""
1976
 
        if not _found:
1977
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
1978
 
            if format.__class__ != self.__class__:
1979
 
                raise AssertionError("wrong format %r found for %r" %
1980
 
                    (format, self))
1981
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1982
 
        try:
1983
 
            control_files = lockable_files.LockableFiles(transport, 'lock',
1984
 
                                                         lockdir.LockDir)
1985
 
            return self._branch_class()(_format=self,
1986
 
                              _control_files=control_files,
1987
 
                              name=name,
1988
 
                              a_bzrdir=a_bzrdir,
1989
 
                              _repository=a_bzrdir.find_repository(),
1990
 
                              ignore_fallbacks=ignore_fallbacks)
1991
 
        except errors.NoSuchFile:
1992
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1993
 
 
1994
 
    def __init__(self):
1995
 
        super(BranchFormatMetadir, self).__init__()
1996
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1997
 
        self._matchingbzrdir.set_branch_format(self)
1998
 
 
1999
 
    def supports_tags(self):
2000
 
        return True
2001
 
 
2002
 
 
2003
 
class BzrBranchFormat5(BranchFormatMetadir):
 
1210
class BzrBranchFormat5(BranchFormat):
2004
1211
    """Bzr branch format 5.
2005
1212
 
2006
1213
    This format has:
2013
1220
    This format is new in bzr 0.8.
2014
1221
    """
2015
1222
 
2016
 
    def _branch_class(self):
2017
 
        return BzrBranch5
2018
 
 
2019
1223
    def get_format_string(self):
2020
1224
        """See BranchFormat.get_format_string()."""
2021
1225
        return "Bazaar-NG branch format 5\n"
2023
1227
    def get_format_description(self):
2024
1228
        """See BranchFormat.get_format_description()."""
2025
1229
        return "Branch format 5"
2026
 
 
2027
 
    def initialize(self, a_bzrdir, name=None):
 
1230
        
 
1231
    def initialize(self, a_bzrdir):
2028
1232
        """Create a branch of this format in a_bzrdir."""
2029
1233
        utf8_files = [('revision-history', ''),
2030
1234
                      ('branch-name', ''),
2031
1235
                      ]
2032
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2033
 
 
2034
 
    def supports_tags(self):
2035
 
        return False
2036
 
 
2037
 
 
2038
 
class BzrBranchFormat6(BranchFormatMetadir):
 
1236
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1237
 
 
1238
    def __init__(self):
 
1239
        super(BzrBranchFormat5, self).__init__()
 
1240
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1241
 
 
1242
    def open(self, a_bzrdir, _found=False):
 
1243
        """Return the branch object for a_bzrdir
 
1244
 
 
1245
        _found is a private parameter, do not use it. It is used to indicate
 
1246
               if format probing has already be done.
 
1247
        """
 
1248
        if not _found:
 
1249
            format = BranchFormat.find_format(a_bzrdir)
 
1250
            if format.__class__ != self.__class__:
 
1251
                raise AssertionError("wrong format %r found for %r" %
 
1252
                    (format, self))
 
1253
        try:
 
1254
            transport = a_bzrdir.get_branch_transport(None)
 
1255
            control_files = lockable_files.LockableFiles(transport, 'lock',
 
1256
                                                         lockdir.LockDir)
 
1257
            return BzrBranch5(_format=self,
 
1258
                              _control_files=control_files,
 
1259
                              a_bzrdir=a_bzrdir,
 
1260
                              _repository=a_bzrdir.find_repository())
 
1261
        except errors.NoSuchFile:
 
1262
            raise errors.NotBranchError(path=transport.base)
 
1263
 
 
1264
 
 
1265
class BzrBranchFormat6(BzrBranchFormat5):
2039
1266
    """Branch format with last-revision and tags.
2040
1267
 
2041
1268
    Unlike previous formats, this has no explicit revision history. Instead,
2046
1273
    and became the default in 0.91.
2047
1274
    """
2048
1275
 
2049
 
    def _branch_class(self):
2050
 
        return BzrBranch6
2051
 
 
2052
1276
    def get_format_string(self):
2053
1277
        """See BranchFormat.get_format_string()."""
2054
1278
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2057
1281
        """See BranchFormat.get_format_description()."""
2058
1282
        return "Branch format 6"
2059
1283
 
2060
 
    def initialize(self, a_bzrdir, name=None):
2061
 
        """Create a branch of this format in a_bzrdir."""
2062
 
        utf8_files = [('last-revision', '0 null:\n'),
2063
 
                      ('branch.conf', ''),
2064
 
                      ('tags', ''),
2065
 
                      ]
2066
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2067
 
 
2068
 
    def make_tags(self, branch):
2069
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2070
 
        return BasicTags(branch)
2071
 
 
2072
 
    def supports_set_append_revisions_only(self):
2073
 
        return True
2074
 
 
2075
 
 
2076
 
class BzrBranchFormat8(BranchFormatMetadir):
2077
 
    """Metadir format supporting storing locations of subtree branches."""
2078
 
 
2079
 
    def _branch_class(self):
2080
 
        return BzrBranch8
2081
 
 
2082
 
    def get_format_string(self):
2083
 
        """See BranchFormat.get_format_string()."""
2084
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2085
 
 
2086
 
    def get_format_description(self):
2087
 
        """See BranchFormat.get_format_description()."""
2088
 
        return "Branch format 8"
2089
 
 
2090
 
    def initialize(self, a_bzrdir, name=None):
2091
 
        """Create a branch of this format in a_bzrdir."""
2092
 
        utf8_files = [('last-revision', '0 null:\n'),
2093
 
                      ('branch.conf', ''),
2094
 
                      ('tags', ''),
2095
 
                      ('references', '')
2096
 
                      ]
2097
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2098
 
 
2099
 
    def __init__(self):
2100
 
        super(BzrBranchFormat8, self).__init__()
2101
 
        self._matchingbzrdir.repository_format = \
2102
 
            RepositoryFormatKnitPack5RichRoot()
2103
 
 
2104
 
    def make_tags(self, branch):
2105
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2106
 
        return BasicTags(branch)
2107
 
 
2108
 
    def supports_set_append_revisions_only(self):
2109
 
        return True
2110
 
 
2111
 
    def supports_stacking(self):
2112
 
        return True
2113
 
 
2114
 
    supports_reference_locations = True
2115
 
 
2116
 
 
2117
 
class BzrBranchFormat7(BzrBranchFormat8):
2118
 
    """Branch format with last-revision, tags, and a stacked location pointer.
2119
 
 
2120
 
    The stacked location pointer is passed down to the repository and requires
2121
 
    a repository format with supports_external_lookups = True.
2122
 
 
2123
 
    This format was introduced in bzr 1.6.
2124
 
    """
2125
 
 
2126
 
    def initialize(self, a_bzrdir, name=None):
2127
 
        """Create a branch of this format in a_bzrdir."""
2128
 
        utf8_files = [('last-revision', '0 null:\n'),
2129
 
                      ('branch.conf', ''),
2130
 
                      ('tags', ''),
2131
 
                      ]
2132
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2133
 
 
2134
 
    def _branch_class(self):
2135
 
        return BzrBranch7
2136
 
 
2137
 
    def get_format_string(self):
2138
 
        """See BranchFormat.get_format_string()."""
2139
 
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2140
 
 
2141
 
    def get_format_description(self):
2142
 
        """See BranchFormat.get_format_description()."""
2143
 
        return "Branch format 7"
2144
 
 
2145
 
    def supports_set_append_revisions_only(self):
2146
 
        return True
2147
 
 
2148
 
    supports_reference_locations = False
 
1284
    def initialize(self, a_bzrdir):
 
1285
        """Create a branch of this format in a_bzrdir."""
 
1286
        utf8_files = [('last-revision', '0 null:\n'),
 
1287
                      ('branch.conf', ''),
 
1288
                      ('tags', ''),
 
1289
                      ]
 
1290
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1291
 
 
1292
    def open(self, a_bzrdir, _found=False):
 
1293
        """Return the branch object for a_bzrdir
 
1294
 
 
1295
        _found is a private parameter, do not use it. It is used to indicate
 
1296
               if format probing has already be done.
 
1297
        """
 
1298
        if not _found:
 
1299
            format = BranchFormat.find_format(a_bzrdir)
 
1300
            if format.__class__ != self.__class__:
 
1301
                raise AssertionError("wrong format %r found for %r" %
 
1302
                    (format, self))
 
1303
        transport = a_bzrdir.get_branch_transport(None)
 
1304
        control_files = lockable_files.LockableFiles(transport, 'lock',
 
1305
                                                     lockdir.LockDir)
 
1306
        return BzrBranch6(_format=self,
 
1307
                          _control_files=control_files,
 
1308
                          a_bzrdir=a_bzrdir,
 
1309
                          _repository=a_bzrdir.find_repository())
 
1310
 
 
1311
    def supports_tags(self):
 
1312
        return True
2149
1313
 
2150
1314
 
2151
1315
class BranchReferenceFormat(BranchFormat):
2170
1334
    def get_reference(self, a_bzrdir):
2171
1335
        """See BranchFormat.get_reference()."""
2172
1336
        transport = a_bzrdir.get_branch_transport(None)
2173
 
        return transport.get_bytes('location')
 
1337
        return transport.get('location').read()
2174
1338
 
2175
1339
    def set_reference(self, a_bzrdir, to_branch):
2176
1340
        """See BranchFormat.set_reference()."""
2177
1341
        transport = a_bzrdir.get_branch_transport(None)
2178
1342
        location = transport.put_bytes('location', to_branch.base)
2179
1343
 
2180
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1344
    def initialize(self, a_bzrdir, target_branch=None):
2181
1345
        """Create a branch of this format in a_bzrdir."""
2182
1346
        if target_branch is None:
2183
1347
            # this format does not implement branch itself, thus the implicit
2184
1348
            # creation contract must see it as uninitializable
2185
1349
            raise errors.UninitializableFormat(self)
2186
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2187
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1350
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1351
        branch_transport = a_bzrdir.get_branch_transport(self)
2188
1352
        branch_transport.put_bytes('location',
2189
 
            target_branch.bzrdir.user_url)
 
1353
            target_branch.bzrdir.root_transport.base)
2190
1354
        branch_transport.put_bytes('format', self.get_format_string())
2191
 
        branch = self.open(
2192
 
            a_bzrdir, name, _found=True,
 
1355
        return self.open(
 
1356
            a_bzrdir, _found=True,
2193
1357
            possible_transports=[target_branch.bzrdir.root_transport])
2194
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2195
 
        return branch
2196
1358
 
2197
1359
    def __init__(self):
2198
1360
        super(BranchReferenceFormat, self).__init__()
2199
1361
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2200
 
        self._matchingbzrdir.set_branch_format(self)
2201
1362
 
2202
1363
    def _make_reference_clone_function(format, a_branch):
2203
1364
        """Create a clone() routine for a branch dynamically."""
2204
 
        def clone(to_bzrdir, revision_id=None,
2205
 
            repository_policy=None):
 
1365
        def clone(to_bzrdir, revision_id=None):
2206
1366
            """See Branch.clone()."""
2207
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1367
            return format.initialize(to_bzrdir, a_branch)
2208
1368
            # cannot obey revision_id limits when cloning a reference ...
2209
1369
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2210
1370
            # emit some sort of warning/error to the caller ?!
2211
1371
        return clone
2212
1372
 
2213
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2214
 
             possible_transports=None, ignore_fallbacks=False):
 
1373
    def open(self, a_bzrdir, _found=False, location=None,
 
1374
             possible_transports=None):
2215
1375
        """Return the branch that the branch reference in a_bzrdir points at.
2216
1376
 
2217
 
        :param a_bzrdir: A BzrDir that contains a branch.
2218
 
        :param name: Name of colocated branch to open, if any
2219
 
        :param _found: a private parameter, do not use it. It is used to
2220
 
            indicate if format probing has already be done.
2221
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2222
 
            (if there are any).  Default is to open fallbacks.
2223
 
        :param location: The location of the referenced branch.  If
2224
 
            unspecified, this will be determined from the branch reference in
2225
 
            a_bzrdir.
2226
 
        :param possible_transports: An optional reusable transports list.
 
1377
        _found is a private parameter, do not use it. It is used to indicate
 
1378
               if format probing has already be done.
2227
1379
        """
2228
1380
        if not _found:
2229
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1381
            format = BranchFormat.find_format(a_bzrdir)
2230
1382
            if format.__class__ != self.__class__:
2231
1383
                raise AssertionError("wrong format %r found for %r" %
2232
1384
                    (format, self))
2234
1386
            location = self.get_reference(a_bzrdir)
2235
1387
        real_bzrdir = bzrdir.BzrDir.open(
2236
1388
            location, possible_transports=possible_transports)
2237
 
        result = real_bzrdir.open_branch(name=name, 
2238
 
            ignore_fallbacks=ignore_fallbacks)
 
1389
        result = real_bzrdir.open_branch()
2239
1390
        # this changes the behaviour of result.clone to create a new reference
2240
1391
        # rather than a copy of the content of the branch.
2241
1392
        # I did not use a proxy object because that needs much more extensive
2248
1399
        return result
2249
1400
 
2250
1401
 
2251
 
network_format_registry = registry.FormatRegistry()
2252
 
"""Registry of formats indexed by their network name.
2253
 
 
2254
 
The network name for a branch format is an identifier that can be used when
2255
 
referring to formats with smart server operations. See
2256
 
BranchFormat.network_name() for more detail.
2257
 
"""
2258
 
 
2259
 
 
2260
1402
# formats which have no format string are not discoverable
2261
1403
# and not independently creatable, so are not registered.
2262
1404
__format5 = BzrBranchFormat5()
2263
1405
__format6 = BzrBranchFormat6()
2264
 
__format7 = BzrBranchFormat7()
2265
 
__format8 = BzrBranchFormat8()
2266
1406
BranchFormat.register_format(__format5)
2267
1407
BranchFormat.register_format(BranchReferenceFormat())
2268
1408
BranchFormat.register_format(__format6)
2269
 
BranchFormat.register_format(__format7)
2270
 
BranchFormat.register_format(__format8)
2271
 
BranchFormat.set_default_format(__format7)
 
1409
BranchFormat.set_default_format(__format6)
2272
1410
_legacy_formats = [BzrBranchFormat4(),
2273
 
    ]
2274
 
network_format_registry.register(
2275
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2276
 
 
2277
 
 
2278
 
class BranchWriteLockResult(LogicalLockResult):
2279
 
    """The result of write locking a branch.
2280
 
 
2281
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2282
 
        None.
2283
 
    :ivar unlock: A callable which will unlock the lock.
2284
 
    """
2285
 
 
2286
 
    def __init__(self, unlock, branch_token):
2287
 
        LogicalLockResult.__init__(self, unlock)
2288
 
        self.branch_token = branch_token
2289
 
 
2290
 
    def __repr__(self):
2291
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2292
 
            self.unlock)
2293
 
 
2294
 
 
2295
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1411
                   ]
 
1412
 
 
1413
class BzrBranch(Branch):
2296
1414
    """A branch stored in the actual filesystem.
2297
1415
 
2298
1416
    Note that it's "local" in the context of the filesystem; it doesn't
2299
1417
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
2300
1418
    it's writable, and can be accessed via the normal filesystem API.
2301
1419
 
2302
 
    :ivar _transport: Transport for file operations on this branch's
 
1420
    :ivar _transport: Transport for file operations on this branch's 
2303
1421
        control files, typically pointing to the .bzr/branch directory.
2304
1422
    :ivar repository: Repository for this branch.
2305
 
    :ivar base: The url of the base directory for this branch; the one
 
1423
    :ivar base: The url of the base directory for this branch; the one 
2306
1424
        containing the .bzr directory.
2307
 
    :ivar name: Optional colocated branch name as it exists in the control
2308
 
        directory.
2309
1425
    """
2310
 
 
 
1426
    
2311
1427
    def __init__(self, _format=None,
2312
 
                 _control_files=None, a_bzrdir=None, name=None,
2313
 
                 _repository=None, ignore_fallbacks=False):
 
1428
                 _control_files=None, a_bzrdir=None, _repository=None):
2314
1429
        """Create new branch object at a particular location."""
 
1430
        Branch.__init__(self)
2315
1431
        if a_bzrdir is None:
2316
1432
            raise ValueError('a_bzrdir must be supplied')
2317
1433
        else:
2318
1434
            self.bzrdir = a_bzrdir
2319
1435
        self._base = self.bzrdir.transport.clone('..').base
2320
 
        self.name = name
2321
1436
        # XXX: We should be able to just do
2322
1437
        #   self.base = self.bzrdir.root_transport.base
2323
1438
        # but this does not quite work yet -- mbp 20080522
2327
1442
        self.control_files = _control_files
2328
1443
        self._transport = _control_files._transport
2329
1444
        self.repository = _repository
2330
 
        Branch.__init__(self)
2331
1445
 
2332
1446
    def __str__(self):
2333
 
        if self.name is None:
2334
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2335
 
        else:
2336
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2337
 
                self.name)
 
1447
        return '%s(%r)' % (self.__class__.__name__, self.base)
2338
1448
 
2339
1449
    __repr__ = __str__
2340
1450
 
2344
1454
 
2345
1455
    base = property(_get_base, doc="The URL for the root of this branch.")
2346
1456
 
2347
 
    def _get_config(self):
2348
 
        return TransportConfig(self._transport, 'branch.conf')
 
1457
    @deprecated_method(deprecated_in((0, 16, 0)))
 
1458
    def abspath(self, name):
 
1459
        """See Branch.abspath."""
 
1460
        return self._transport.abspath(name)
2349
1461
 
2350
1462
    def is_locked(self):
2351
1463
        return self.control_files.is_locked()
2352
1464
 
2353
1465
    def lock_write(self, token=None):
2354
 
        """Lock the branch for write operations.
2355
 
 
2356
 
        :param token: A token to permit reacquiring a previously held and
2357
 
            preserved lock.
2358
 
        :return: A BranchWriteLockResult.
2359
 
        """
2360
 
        if not self.is_locked():
2361
 
            self._note_lock('w')
2362
 
        # All-in-one needs to always unlock/lock.
2363
 
        repo_control = getattr(self.repository, 'control_files', None)
2364
 
        if self.control_files == repo_control or not self.is_locked():
2365
 
            self.repository._warn_if_deprecated(self)
2366
 
            self.repository.lock_write()
2367
 
            took_lock = True
2368
 
        else:
2369
 
            took_lock = False
 
1466
        repo_token = self.repository.lock_write()
2370
1467
        try:
2371
 
            return BranchWriteLockResult(self.unlock,
2372
 
                self.control_files.lock_write(token=token))
 
1468
            token = self.control_files.lock_write(token=token)
2373
1469
        except:
2374
 
            if took_lock:
2375
 
                self.repository.unlock()
 
1470
            self.repository.unlock()
2376
1471
            raise
 
1472
        return token
2377
1473
 
2378
1474
    def lock_read(self):
2379
 
        """Lock the branch for read operations.
2380
 
 
2381
 
        :return: A bzrlib.lock.LogicalLockResult.
2382
 
        """
2383
 
        if not self.is_locked():
2384
 
            self._note_lock('r')
2385
 
        # All-in-one needs to always unlock/lock.
2386
 
        repo_control = getattr(self.repository, 'control_files', None)
2387
 
        if self.control_files == repo_control or not self.is_locked():
2388
 
            self.repository._warn_if_deprecated(self)
2389
 
            self.repository.lock_read()
2390
 
            took_lock = True
2391
 
        else:
2392
 
            took_lock = False
 
1475
        self.repository.lock_read()
2393
1476
        try:
2394
1477
            self.control_files.lock_read()
2395
 
            return LogicalLockResult(self.unlock)
2396
1478
        except:
2397
 
            if took_lock:
2398
 
                self.repository.unlock()
 
1479
            self.repository.unlock()
2399
1480
            raise
2400
1481
 
2401
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2402
1482
    def unlock(self):
 
1483
        # TODO: test for failed two phase locks. This is known broken.
2403
1484
        try:
2404
1485
            self.control_files.unlock()
2405
1486
        finally:
2406
 
            # All-in-one needs to always unlock/lock.
2407
 
            repo_control = getattr(self.repository, 'control_files', None)
2408
 
            if (self.control_files == repo_control or
2409
 
                not self.control_files.is_locked()):
2410
 
                self.repository.unlock()
2411
 
            if not self.control_files.is_locked():
2412
 
                # we just released the lock
2413
 
                self._clear_cached_state()
2414
 
 
 
1487
            self.repository.unlock()
 
1488
        if not self.control_files.is_locked():
 
1489
            # we just released the lock
 
1490
            self._clear_cached_state()
 
1491
        
2415
1492
    def peek_lock_mode(self):
2416
1493
        if self.control_files._lock_count == 0:
2417
1494
            return None
2443
1520
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2444
1521
        for rev_id in rev_history:
2445
1522
            check_not_reserved_id(rev_id)
2446
 
        if Branch.hooks['post_change_branch_tip']:
2447
 
            # Don't calculate the last_revision_info() if there are no hooks
2448
 
            # that will use it.
2449
 
            old_revno, old_revid = self.last_revision_info()
2450
 
        if len(rev_history) == 0:
2451
 
            revid = _mod_revision.NULL_REVISION
2452
 
        else:
2453
 
            revid = rev_history[-1]
2454
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2455
1523
        self._write_revision_history(rev_history)
2456
1524
        self._clear_cached_state()
2457
1525
        self._cache_revision_history(rev_history)
2458
1526
        for hook in Branch.hooks['set_rh']:
2459
1527
            hook(self, rev_history)
2460
 
        if Branch.hooks['post_change_branch_tip']:
2461
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2462
 
 
2463
 
    def _synchronize_history(self, destination, revision_id):
2464
 
        """Synchronize last revision and revision history between branches.
2465
 
 
2466
 
        This version is most efficient when the destination is also a
2467
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2468
 
        history is the true lefthand parent history, and all of the revisions
2469
 
        are in the destination's repository.  If not, set_revision_history
2470
 
        will fail.
2471
 
 
2472
 
        :param destination: The branch to copy the history into
2473
 
        :param revision_id: The revision-id to truncate history at.  May
2474
 
          be None to copy complete history.
2475
 
        """
2476
 
        if not isinstance(destination._format, BzrBranchFormat5):
2477
 
            super(BzrBranch, self)._synchronize_history(
2478
 
                destination, revision_id)
2479
 
            return
2480
 
        if revision_id == _mod_revision.NULL_REVISION:
2481
 
            new_history = []
2482
 
        else:
2483
 
            new_history = self.revision_history()
2484
 
        if revision_id is not None and new_history != []:
2485
 
            try:
2486
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2487
 
            except ValueError:
2488
 
                rev = self.repository.get_revision(revision_id)
2489
 
                new_history = rev.get_history(self.repository)[1:]
2490
 
        destination.set_revision_history(new_history)
2491
 
 
 
1528
 
 
1529
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1530
        """Run the pre_change_branch_tip hooks."""
 
1531
        hooks = Branch.hooks['pre_change_branch_tip']
 
1532
        if not hooks:
 
1533
            return
 
1534
        old_revno, old_revid = self.last_revision_info()
 
1535
        params = ChangeBranchTipParams(
 
1536
            self, old_revno, new_revno, old_revid, new_revid)
 
1537
        for hook in hooks:
 
1538
            hook(params)
 
1539
 
 
1540
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1541
        """Run the post_change_branch_tip hooks."""
 
1542
        hooks = Branch.hooks['post_change_branch_tip']
 
1543
        if not hooks:
 
1544
            return
 
1545
        new_revno, new_revid = self.last_revision_info()
 
1546
        params = ChangeBranchTipParams(
 
1547
            self, old_revno, new_revno, old_revid, new_revid)
 
1548
        for hook in hooks:
 
1549
            hook(params)
 
1550
 
2492
1551
    @needs_write_lock
2493
1552
    def set_last_revision_info(self, revno, revision_id):
2494
1553
        """Set the last revision of this branch.
2497
1556
        for this revision id.
2498
1557
 
2499
1558
        It may be possible to set the branch last revision to an id not
2500
 
        present in the repository.  However, branches can also be
 
1559
        present in the repository.  However, branches can also be 
2501
1560
        configured to check constraints on history, in which case this may not
2502
1561
        be permitted.
2503
1562
        """
2504
1563
        revision_id = _mod_revision.ensure_null(revision_id)
 
1564
        old_revno, old_revid = self.last_revision_info()
2505
1565
        # this old format stores the full history, but this api doesn't
2506
1566
        # provide it, so we must generate, and might as well check it's
2507
1567
        # correct
2508
1568
        history = self._lefthand_history(revision_id)
2509
1569
        if len(history) != revno:
2510
1570
            raise AssertionError('%d != %d' % (len(history), revno))
 
1571
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2511
1572
        self.set_revision_history(history)
 
1573
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2512
1574
 
2513
1575
    def _gen_revision_history(self):
2514
1576
        history = self._transport.get_bytes('revision-history').split('\n')
2517
1579
            history.pop()
2518
1580
        return history
2519
1581
 
 
1582
    def _lefthand_history(self, revision_id, last_rev=None,
 
1583
                          other_branch=None):
 
1584
        if 'evil' in debug.debug_flags:
 
1585
            mutter_callsite(4, "_lefthand_history scales with history.")
 
1586
        # stop_revision must be a descendant of last_revision
 
1587
        graph = self.repository.get_graph()
 
1588
        if last_rev is not None:
 
1589
            if not graph.is_ancestor(last_rev, revision_id):
 
1590
                # our previous tip is not merged into stop_revision
 
1591
                raise errors.DivergedBranches(self, other_branch)
 
1592
        # make a new revision history from the graph
 
1593
        parents_map = graph.get_parent_map([revision_id])
 
1594
        if revision_id not in parents_map:
 
1595
            raise errors.NoSuchRevision(self, revision_id)
 
1596
        current_rev_id = revision_id
 
1597
        new_history = []
 
1598
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
1599
        # Do not include ghosts or graph origin in revision_history
 
1600
        while (current_rev_id in parents_map and
 
1601
               len(parents_map[current_rev_id]) > 0):
 
1602
            check_not_reserved_id(current_rev_id)
 
1603
            new_history.append(current_rev_id)
 
1604
            current_rev_id = parents_map[current_rev_id][0]
 
1605
            parents_map = graph.get_parent_map([current_rev_id])
 
1606
        new_history.reverse()
 
1607
        return new_history
 
1608
 
2520
1609
    @needs_write_lock
2521
1610
    def generate_revision_history(self, revision_id, last_rev=None,
2522
1611
        other_branch=None):
2535
1624
        """See Branch.basis_tree."""
2536
1625
        return self.repository.revision_tree(self.last_revision())
2537
1626
 
 
1627
    @needs_write_lock
 
1628
    def pull(self, source, overwrite=False, stop_revision=None,
 
1629
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1630
             _override_hook_target=None):
 
1631
        """See Branch.pull.
 
1632
 
 
1633
        :param _hook_master: Private parameter - set the branch to 
 
1634
            be supplied as the master to pull hooks.
 
1635
        :param run_hooks: Private parameter - if false, this branch
 
1636
            is being called because it's the master of the primary branch,
 
1637
            so it should not run its hooks.
 
1638
        :param _override_hook_target: Private parameter - set the branch to be
 
1639
            supplied as the target_branch to pull hooks.
 
1640
        """
 
1641
        result = PullResult()
 
1642
        result.source_branch = source
 
1643
        if _override_hook_target is None:
 
1644
            result.target_branch = self
 
1645
        else:
 
1646
            result.target_branch = _override_hook_target
 
1647
        source.lock_read()
 
1648
        try:
 
1649
            # We assume that during 'pull' the local repository is closer than
 
1650
            # the remote one.
 
1651
            graph = self.repository.get_graph(source.repository)
 
1652
            result.old_revno, result.old_revid = self.last_revision_info()
 
1653
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1654
                                  graph=graph)
 
1655
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1656
            result.new_revno, result.new_revid = self.last_revision_info()
 
1657
            if _hook_master:
 
1658
                result.master_branch = _hook_master
 
1659
                result.local_branch = result.target_branch
 
1660
            else:
 
1661
                result.master_branch = result.target_branch
 
1662
                result.local_branch = None
 
1663
            if run_hooks:
 
1664
                for hook in Branch.hooks['post_pull']:
 
1665
                    hook(result)
 
1666
        finally:
 
1667
            source.unlock()
 
1668
        return result
 
1669
 
2538
1670
    def _get_parent_location(self):
2539
1671
        _locs = ['parent', 'pull', 'x-pull']
2540
1672
        for l in _locs:
2544
1676
                pass
2545
1677
        return None
2546
1678
 
 
1679
    @needs_read_lock
 
1680
    def push(self, target, overwrite=False, stop_revision=None,
 
1681
             _override_hook_source_branch=None):
 
1682
        """See Branch.push.
 
1683
 
 
1684
        This is the basic concrete implementation of push()
 
1685
 
 
1686
        :param _override_hook_source_branch: If specified, run
 
1687
        the hooks passing this Branch as the source, rather than self.  
 
1688
        This is for use of RemoteBranch, where push is delegated to the
 
1689
        underlying vfs-based Branch. 
 
1690
        """
 
1691
        # TODO: Public option to disable running hooks - should be trivial but
 
1692
        # needs tests.
 
1693
        target.lock_write()
 
1694
        try:
 
1695
            result = self._push_with_bound_branches(target, overwrite,
 
1696
                    stop_revision,
 
1697
                    _override_hook_source_branch=_override_hook_source_branch)
 
1698
            return result
 
1699
        finally:
 
1700
            target.unlock()
 
1701
 
 
1702
    def _push_with_bound_branches(self, target, overwrite,
 
1703
            stop_revision,
 
1704
            _override_hook_source_branch=None):
 
1705
        """Push from self into target, and into target's master if any.
 
1706
        
 
1707
        This is on the base BzrBranch class even though it doesn't support 
 
1708
        bound branches because the *target* might be bound.
 
1709
        """
 
1710
        def _run_hooks():
 
1711
            if _override_hook_source_branch:
 
1712
                result.source_branch = _override_hook_source_branch
 
1713
            for hook in Branch.hooks['post_push']:
 
1714
                hook(result)
 
1715
 
 
1716
        bound_location = target.get_bound_location()
 
1717
        if bound_location and target.base != bound_location:
 
1718
            # there is a master branch.
 
1719
            #
 
1720
            # XXX: Why the second check?  Is it even supported for a branch to
 
1721
            # be bound to itself? -- mbp 20070507
 
1722
            master_branch = target.get_master_branch()
 
1723
            master_branch.lock_write()
 
1724
            try:
 
1725
                # push into the master from this branch.
 
1726
                self._basic_push(master_branch, overwrite, stop_revision)
 
1727
                # and push into the target branch from this. Note that we push from
 
1728
                # this branch again, because its considered the highest bandwidth
 
1729
                # repository.
 
1730
                result = self._basic_push(target, overwrite, stop_revision)
 
1731
                result.master_branch = master_branch
 
1732
                result.local_branch = target
 
1733
                _run_hooks()
 
1734
                return result
 
1735
            finally:
 
1736
                master_branch.unlock()
 
1737
        else:
 
1738
            # no master branch
 
1739
            result = self._basic_push(target, overwrite, stop_revision)
 
1740
            # TODO: Why set master_branch and local_branch if there's no
 
1741
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
1742
            # 20070504
 
1743
            result.master_branch = target
 
1744
            result.local_branch = None
 
1745
            _run_hooks()
 
1746
            return result
 
1747
 
2547
1748
    def _basic_push(self, target, overwrite, stop_revision):
2548
1749
        """Basic implementation of push without bound branches or hooks.
2549
1750
 
2550
 
        Must be called with source read locked and target write locked.
 
1751
        Must be called with self read locked and target write locked.
2551
1752
        """
2552
 
        result = BranchPushResult()
 
1753
        result = PushResult()
2553
1754
        result.source_branch = self
2554
1755
        result.target_branch = target
2555
1756
        result.old_revno, result.old_revid = target.last_revision_info()
2556
 
        self.update_references(target)
2557
 
        if result.old_revid != self.last_revision():
2558
 
            # We assume that during 'push' this repository is closer than
2559
 
            # the target.
2560
 
            graph = self.repository.get_graph(target.repository)
2561
 
            target.update_revisions(self, stop_revision,
2562
 
                overwrite=overwrite, graph=graph)
2563
 
        if self._push_should_merge_tags():
2564
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2565
 
                overwrite)
 
1757
 
 
1758
        # We assume that during 'push' this repository is closer than
 
1759
        # the target.
 
1760
        graph = self.repository.get_graph(target.repository)
 
1761
        target.update_revisions(self, stop_revision, overwrite=overwrite,
 
1762
                                graph=graph)
 
1763
        result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2566
1764
        result.new_revno, result.new_revid = target.last_revision_info()
2567
1765
        return result
2568
1766
 
2569
 
    def get_stacked_on_url(self):
2570
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
1767
    def get_parent(self):
 
1768
        """See Branch.get_parent."""
 
1769
        parent = self._get_parent_location()
 
1770
        if parent is None:
 
1771
            return parent
 
1772
        # This is an old-format absolute path to a local branch
 
1773
        # turn it into a url
 
1774
        if parent.startswith('/'):
 
1775
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1776
        try:
 
1777
            return urlutils.join(self.base[:-1], parent)
 
1778
        except errors.InvalidURLJoin, e:
 
1779
            raise errors.InaccessibleParent(parent, self.base)
2571
1780
 
2572
1781
    def set_push_location(self, location):
2573
1782
        """See Branch.set_push_location."""
2575
1784
            'push_location', location,
2576
1785
            store=_mod_config.STORE_LOCATION_NORECURSE)
2577
1786
 
 
1787
    @needs_write_lock
 
1788
    def set_parent(self, url):
 
1789
        """See Branch.set_parent."""
 
1790
        # TODO: Maybe delete old location files?
 
1791
        # URLs should never be unicode, even on the local fs,
 
1792
        # FIXUP this and get_parent in a future branch format bump:
 
1793
        # read and rewrite the file. RBC 20060125
 
1794
        if url is not None:
 
1795
            if isinstance(url, unicode):
 
1796
                try:
 
1797
                    url = url.encode('ascii')
 
1798
                except UnicodeEncodeError:
 
1799
                    raise errors.InvalidURL(url,
 
1800
                        "Urls must be 7-bit ascii, "
 
1801
                        "use bzrlib.urlutils.escape")
 
1802
            url = urlutils.relative_url(self.base, url)
 
1803
        self._set_parent_location(url)
 
1804
 
2578
1805
    def _set_parent_location(self, url):
2579
1806
        if url is None:
2580
1807
            self._transport.delete('parent')
2589
1816
    It has support for a master_branch which is the data for bound branches.
2590
1817
    """
2591
1818
 
 
1819
    def __init__(self,
 
1820
                 _format,
 
1821
                 _control_files,
 
1822
                 a_bzrdir,
 
1823
                 _repository):
 
1824
        super(BzrBranch5, self).__init__(_format=_format,
 
1825
                                         _control_files=_control_files,
 
1826
                                         a_bzrdir=a_bzrdir,
 
1827
                                         _repository=_repository)
 
1828
        
 
1829
    @needs_write_lock
 
1830
    def pull(self, source, overwrite=False, stop_revision=None,
 
1831
             run_hooks=True, possible_transports=None,
 
1832
             _override_hook_target=None):
 
1833
        """Pull from source into self, updating my master if any.
 
1834
        
 
1835
        :param run_hooks: Private parameter - if false, this branch
 
1836
            is being called because it's the master of the primary branch,
 
1837
            so it should not run its hooks.
 
1838
        """
 
1839
        bound_location = self.get_bound_location()
 
1840
        master_branch = None
 
1841
        if bound_location and source.base != bound_location:
 
1842
            # not pulling from master, so we need to update master.
 
1843
            master_branch = self.get_master_branch(possible_transports)
 
1844
            master_branch.lock_write()
 
1845
        try:
 
1846
            if master_branch:
 
1847
                # pull from source into master.
 
1848
                master_branch.pull(source, overwrite, stop_revision,
 
1849
                    run_hooks=False)
 
1850
            return super(BzrBranch5, self).pull(source, overwrite,
 
1851
                stop_revision, _hook_master=master_branch,
 
1852
                run_hooks=run_hooks,
 
1853
                _override_hook_target=_override_hook_target)
 
1854
        finally:
 
1855
            if master_branch:
 
1856
                master_branch.unlock()
 
1857
 
2592
1858
    def get_bound_location(self):
2593
1859
        try:
2594
1860
            return self._transport.get_bytes('bound')[:-1]
2598
1864
    @needs_read_lock
2599
1865
    def get_master_branch(self, possible_transports=None):
2600
1866
        """Return the branch we are bound to.
2601
 
 
 
1867
        
2602
1868
        :return: Either a Branch, or None
2603
1869
 
2604
1870
        This could memoise the branch, but if thats done
2640
1906
        check for divergence to raise an error when the branches are not
2641
1907
        either the same, or one a prefix of the other. That behaviour may not
2642
1908
        be useful, so that check may be removed in future.
2643
 
 
 
1909
        
2644
1910
        :param other: The branch to bind to
2645
1911
        :type other: Branch
2646
1912
        """
2665
1931
 
2666
1932
    @needs_write_lock
2667
1933
    def update(self, possible_transports=None):
2668
 
        """Synchronise this branch with the master branch if any.
 
1934
        """Synchronise this branch with the master branch if any. 
2669
1935
 
2670
1936
        :return: None or the last_revision that was pivoted out during the
2671
1937
                 update.
2681
1947
        return None
2682
1948
 
2683
1949
 
2684
 
class BzrBranch8(BzrBranch5):
2685
 
    """A branch that stores tree-reference locations."""
2686
 
 
2687
 
    def _open_hook(self):
2688
 
        if self._ignore_fallbacks:
2689
 
            return
2690
 
        try:
2691
 
            url = self.get_stacked_on_url()
2692
 
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2693
 
            errors.UnstackableBranchFormat):
2694
 
            pass
2695
 
        else:
2696
 
            for hook in Branch.hooks['transform_fallback_location']:
2697
 
                url = hook(self, url)
2698
 
                if url is None:
2699
 
                    hook_name = Branch.hooks.get_hook_name(hook)
2700
 
                    raise AssertionError(
2701
 
                        "'transform_fallback_location' hook %s returned "
2702
 
                        "None, not a URL." % hook_name)
2703
 
            self._activate_fallback_location(url)
 
1950
class BzrBranch6(BzrBranch5):
2704
1951
 
2705
1952
    def __init__(self, *args, **kwargs):
2706
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2707
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
2708
 
        self._last_revision_info_cache = None
2709
 
        self._reference_info = None
 
1953
        super(BzrBranch6, self).__init__(*args, **kwargs)
 
1954
        self._partial_revision_history_cache = []
2710
1955
 
2711
1956
    def _clear_cached_state(self):
2712
 
        super(BzrBranch8, self)._clear_cached_state()
2713
 
        self._last_revision_info_cache = None
2714
 
        self._reference_info = None
 
1957
        super(BzrBranch6, self)._clear_cached_state()
 
1958
        self._partial_revision_history_cache = []
2715
1959
 
2716
1960
    def _last_revision_info(self):
2717
1961
        revision_string = self._transport.get_bytes('last-revision')
2746
1990
        self._last_revision_info_cache = revno, revision_id
2747
1991
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2748
1992
 
2749
 
    def _synchronize_history(self, destination, revision_id):
2750
 
        """Synchronize last revision and revision history between branches.
2751
 
 
2752
 
        :see: Branch._synchronize_history
2753
 
        """
2754
 
        # XXX: The base Branch has a fast implementation of this method based
2755
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2756
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2757
 
        # but wants the fast implementation, so it calls
2758
 
        # Branch._synchronize_history directly.
2759
 
        Branch._synchronize_history(self, destination, revision_id)
2760
 
 
2761
1993
    def _check_history_violation(self, revision_id):
2762
1994
        last_revision = _mod_revision.ensure_null(self.last_revision())
2763
1995
        if _mod_revision.is_null(last_revision):
2764
1996
            return
2765
1997
        if last_revision not in self._lefthand_history(revision_id):
2766
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
1998
            raise errors.AppendRevisionsOnlyViolation(self.base)
2767
1999
 
2768
2000
    def _gen_revision_history(self):
2769
2001
        """Generate the revision history from last revision
2772
2004
        self._extend_partial_history(stop_index=last_revno-1)
2773
2005
        return list(reversed(self._partial_revision_history_cache))
2774
2006
 
 
2007
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2008
        """Extend the partial history to include a given index
 
2009
 
 
2010
        If a stop_index is supplied, stop when that index has been reached.
 
2011
        If a stop_revision is supplied, stop when that revision is
 
2012
        encountered.  Otherwise, stop when the beginning of history is
 
2013
        reached.
 
2014
 
 
2015
        :param stop_index: The index which should be present.  When it is
 
2016
            present, history extension will stop.
 
2017
        :param revision_id: The revision id which should be present.  When
 
2018
            it is encountered, history extension will stop.
 
2019
        """
 
2020
        repo = self.repository
 
2021
        if len(self._partial_revision_history_cache) == 0:
 
2022
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2023
        else:
 
2024
            start_revision = self._partial_revision_history_cache[-1]
 
2025
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2026
            #skip the last revision in the list
 
2027
            next_revision = iterator.next()
 
2028
        for revision_id in iterator:
 
2029
            self._partial_revision_history_cache.append(revision_id)
 
2030
            if (stop_index is not None and
 
2031
                len(self._partial_revision_history_cache) > stop_index):
 
2032
                break
 
2033
            if revision_id == stop_revision:
 
2034
                break
 
2035
 
2775
2036
    def _write_revision_history(self, history):
2776
2037
        """Factored out of set_revision_history.
2777
2038
 
2798
2059
        """Set the parent branch"""
2799
2060
        return self._get_config_location('parent_location')
2800
2061
 
2801
 
    @needs_write_lock
2802
 
    def _set_all_reference_info(self, info_dict):
2803
 
        """Replace all reference info stored in a branch.
2804
 
 
2805
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2806
 
        """
2807
 
        s = StringIO()
2808
 
        writer = rio.RioWriter(s)
2809
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2810
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2811
 
                                branch_location=branch_location)
2812
 
            writer.write_stanza(stanza)
2813
 
        self._transport.put_bytes('references', s.getvalue())
2814
 
        self._reference_info = info_dict
2815
 
 
2816
 
    @needs_read_lock
2817
 
    def _get_all_reference_info(self):
2818
 
        """Return all the reference info stored in a branch.
2819
 
 
2820
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2821
 
        """
2822
 
        if self._reference_info is not None:
2823
 
            return self._reference_info
2824
 
        rio_file = self._transport.get('references')
2825
 
        try:
2826
 
            stanzas = rio.read_stanzas(rio_file)
2827
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2828
 
                             s['branch_location'])) for s in stanzas)
2829
 
        finally:
2830
 
            rio_file.close()
2831
 
        self._reference_info = info_dict
2832
 
        return info_dict
2833
 
 
2834
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2835
 
        """Set the branch location to use for a tree reference.
2836
 
 
2837
 
        :param file_id: The file-id of the tree reference.
2838
 
        :param tree_path: The path of the tree reference in the tree.
2839
 
        :param branch_location: The location of the branch to retrieve tree
2840
 
            references from.
2841
 
        """
2842
 
        info_dict = self._get_all_reference_info()
2843
 
        info_dict[file_id] = (tree_path, branch_location)
2844
 
        if None in (tree_path, branch_location):
2845
 
            if tree_path is not None:
2846
 
                raise ValueError('tree_path must be None when branch_location'
2847
 
                                 ' is None.')
2848
 
            if branch_location is not None:
2849
 
                raise ValueError('branch_location must be None when tree_path'
2850
 
                                 ' is None.')
2851
 
            del info_dict[file_id]
2852
 
        self._set_all_reference_info(info_dict)
2853
 
 
2854
 
    def get_reference_info(self, file_id):
2855
 
        """Get the tree_path and branch_location for a tree reference.
2856
 
 
2857
 
        :return: a tuple of (tree_path, branch_location)
2858
 
        """
2859
 
        return self._get_all_reference_info().get(file_id, (None, None))
2860
 
 
2861
 
    def reference_parent(self, file_id, path, possible_transports=None):
2862
 
        """Return the parent branch for a tree-reference file_id.
2863
 
 
2864
 
        :param file_id: The file_id of the tree reference
2865
 
        :param path: The path of the file_id in the tree
2866
 
        :return: A branch associated with the file_id
2867
 
        """
2868
 
        branch_location = self.get_reference_info(file_id)[1]
2869
 
        if branch_location is None:
2870
 
            return Branch.reference_parent(self, file_id, path,
2871
 
                                           possible_transports)
2872
 
        branch_location = urlutils.join(self.user_url, branch_location)
2873
 
        return Branch.open(branch_location,
2874
 
                           possible_transports=possible_transports)
2875
 
 
2876
2062
    def set_push_location(self, location):
2877
2063
        """See Branch.set_push_location."""
2878
2064
        self._set_config_location('push_location', location)
2911
2097
        """See Branch.get_old_bound_location"""
2912
2098
        return self._get_bound_location(False)
2913
2099
 
2914
 
    def get_stacked_on_url(self):
2915
 
        # you can always ask for the URL; but you might not be able to use it
2916
 
        # if the repo can't support stacking.
2917
 
        ## self._check_stackable_repo()
2918
 
        stacked_url = self._get_config_location('stacked_on_location')
2919
 
        if stacked_url is None:
2920
 
            raise errors.NotStacked(self)
2921
 
        return stacked_url
 
2100
    def set_append_revisions_only(self, enabled):
 
2101
        if enabled:
 
2102
            value = 'True'
 
2103
        else:
 
2104
            value = 'False'
 
2105
        self.get_config().set_user_option('append_revisions_only', value,
 
2106
            warn_masked=True)
2922
2107
 
2923
2108
    def _get_append_revisions_only(self):
2924
 
        return self.get_config(
2925
 
            ).get_user_option_as_bool('append_revisions_only')
 
2109
        value = self.get_config().get_user_option('append_revisions_only')
 
2110
        return value == 'True'
 
2111
 
 
2112
    def _synchronize_history(self, destination, revision_id):
 
2113
        """Synchronize last revision and revision history between branches.
 
2114
 
 
2115
        This version is most efficient when the destination is also a
 
2116
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
2117
        repository contains all the lefthand ancestors of the intended
 
2118
        last_revision.  If not, set_last_revision_info will fail.
 
2119
 
 
2120
        :param destination: The branch to copy the history into
 
2121
        :param revision_id: The revision-id to truncate history at.  May
 
2122
          be None to copy complete history.
 
2123
        """
 
2124
        source_revno, source_revision_id = self.last_revision_info()
 
2125
        if revision_id is None:
 
2126
            revno, revision_id = source_revno, source_revision_id
 
2127
        elif source_revision_id == revision_id:
 
2128
            # we know the revno without needing to walk all of history
 
2129
            revno = source_revno
 
2130
        else:
 
2131
            # To figure out the revno for a random revision, we need to build
 
2132
            # the revision history, and count its length.
 
2133
            # We don't care about the order, just how long it is.
 
2134
            # Alternatively, we could start at the current location, and count
 
2135
            # backwards. But there is no guarantee that we will find it since
 
2136
            # it may be a merged revision.
 
2137
            revno = len(list(self.repository.iter_reverse_revision_history(
 
2138
                                                                revision_id)))
 
2139
        destination.set_last_revision_info(revno, revision_id)
 
2140
 
 
2141
    def _make_tags(self):
 
2142
        return BasicTags(self)
2926
2143
 
2927
2144
    @needs_write_lock
2928
2145
    def generate_revision_history(self, revision_id, last_rev=None,
2968
2185
        return self.revno() - index
2969
2186
 
2970
2187
 
2971
 
class BzrBranch7(BzrBranch8):
2972
 
    """A branch with support for a fallback repository."""
2973
 
 
2974
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2975
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2976
 
 
2977
 
    def get_reference_info(self, file_id):
2978
 
        Branch.get_reference_info(self, file_id)
2979
 
 
2980
 
    def reference_parent(self, file_id, path, possible_transports=None):
2981
 
        return Branch.reference_parent(self, file_id, path,
2982
 
                                       possible_transports)
2983
 
 
2984
 
 
2985
 
class BzrBranch6(BzrBranch7):
2986
 
    """See BzrBranchFormat6 for the capabilities of this branch.
2987
 
 
2988
 
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2989
 
    i.e. stacking.
2990
 
    """
2991
 
 
2992
 
    def get_stacked_on_url(self):
2993
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2994
 
 
2995
 
 
2996
2188
######################################################################
2997
2189
# results of operations
2998
2190
 
3014
2206
    :ivar new_revno: Revision number after pull.
3015
2207
    :ivar old_revid: Tip revision id before pull.
3016
2208
    :ivar new_revid: Tip revision id after pull.
3017
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2209
    :ivar source_branch: Source (local) branch object.
3018
2210
    :ivar master_branch: Master branch of the target, or the target if no
3019
2211
        Master
3020
2212
    :ivar local_branch: target branch if there is a Master, else None
3021
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2213
    :ivar target_branch: Target/destination branch object.
3022
2214
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3023
2215
    """
3024
2216
 
3035
2227
        self._show_tag_conficts(to_file)
3036
2228
 
3037
2229
 
3038
 
class BranchPushResult(_Result):
 
2230
class PushResult(_Result):
3039
2231
    """Result of a Branch.push operation.
3040
2232
 
3041
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3042
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3043
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3044
 
        before the push.
3045
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3046
 
        after the push.
3047
 
    :ivar source_branch: Source branch object that the push was from. This is
3048
 
        read locked, and generally is a local (and thus low latency) branch.
3049
 
    :ivar master_branch: If target is a bound branch, the master branch of
3050
 
        target, or target itself. Always write locked.
3051
 
    :ivar target_branch: The direct Branch where data is being sent (write
3052
 
        locked).
3053
 
    :ivar local_branch: If the target is a bound branch this will be the
3054
 
        target, otherwise it will be None.
 
2233
    :ivar old_revno: Revision number before push.
 
2234
    :ivar new_revno: Revision number after push.
 
2235
    :ivar old_revid: Tip revision id before push.
 
2236
    :ivar new_revid: Tip revision id after push.
 
2237
    :ivar source_branch: Source branch object.
 
2238
    :ivar master_branch: Master branch of the target, or None.
 
2239
    :ivar target_branch: Target/destination branch object.
3055
2240
    """
3056
2241
 
3057
2242
    def __int__(self):
3061
2246
    def report(self, to_file):
3062
2247
        """Write a human-readable description of the result."""
3063
2248
        if self.old_revid == self.new_revid:
3064
 
            note('No new revisions to push.')
 
2249
            to_file.write('No new revisions to push.\n')
3065
2250
        else:
3066
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2251
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3067
2252
        self._show_tag_conficts(to_file)
3068
2253
 
3069
2254
 
3075
2260
 
3076
2261
    def __init__(self, branch):
3077
2262
        self.branch = branch
3078
 
        self.errors = []
3079
2263
 
3080
2264
    def report_results(self, verbose):
3081
2265
        """Report the check results via trace.note.
3082
 
 
 
2266
        
3083
2267
        :param verbose: Requests more detailed display of what was checked,
3084
2268
            if any.
3085
2269
        """
3086
 
        note('checked branch %s format %s', self.branch.user_url,
3087
 
            self.branch._format)
3088
 
        for error in self.errors:
3089
 
            note('found error:%s', error)
 
2270
        note('checked branch %s format %s',
 
2271
             self.branch.base,
 
2272
             self.branch._format)
3090
2273
 
3091
2274
 
3092
2275
class Converter5to6(object):
3118
2301
        except errors.NoSuchFile:
3119
2302
            pass
3120
2303
        branch.set_bound_location(None)
3121
 
 
3122
 
 
3123
 
class Converter6to7(object):
3124
 
    """Perform an in-place upgrade of format 6 to format 7"""
3125
 
 
3126
 
    def convert(self, branch):
3127
 
        format = BzrBranchFormat7()
3128
 
        branch._set_config_location('stacked_on_location', '')
3129
 
        # update target format
3130
 
        branch._transport.put_bytes('format', format.get_format_string())
3131
 
 
3132
 
 
3133
 
class Converter7to8(object):
3134
 
    """Perform an in-place upgrade of format 6 to format 7"""
3135
 
 
3136
 
    def convert(self, branch):
3137
 
        format = BzrBranchFormat8()
3138
 
        branch._transport.put_bytes('references', '')
3139
 
        # update target format
3140
 
        branch._transport.put_bytes('format', format.get_format_string())
3141
 
 
3142
 
 
3143
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3144
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3145
 
    duration.
3146
 
 
3147
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
3148
 
 
3149
 
    If an exception is raised by callable, then that exception *will* be
3150
 
    propagated, even if the unlock attempt raises its own error.  Thus
3151
 
    _run_with_write_locked_target should be preferred to simply doing::
3152
 
 
3153
 
        target.lock_write()
3154
 
        try:
3155
 
            return callable(*args, **kwargs)
3156
 
        finally:
3157
 
            target.unlock()
3158
 
 
3159
 
    """
3160
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3161
 
    # should share code?
3162
 
    target.lock_write()
3163
 
    try:
3164
 
        result = callable(*args, **kwargs)
3165
 
    except:
3166
 
        exc_info = sys.exc_info()
3167
 
        try:
3168
 
            target.unlock()
3169
 
        finally:
3170
 
            raise exc_info[0], exc_info[1], exc_info[2]
3171
 
    else:
3172
 
        target.unlock()
3173
 
        return result
3174
 
 
3175
 
 
3176
 
class InterBranch(InterObject):
3177
 
    """This class represents operations taking place between two branches.
3178
 
 
3179
 
    Its instances have methods like pull() and push() and contain
3180
 
    references to the source and target repositories these operations
3181
 
    can be carried out on.
3182
 
    """
3183
 
 
3184
 
    _optimisers = []
3185
 
    """The available optimised InterBranch types."""
3186
 
 
3187
 
    @staticmethod
3188
 
    def _get_branch_formats_to_test():
3189
 
        """Return a tuple with the Branch formats to use when testing."""
3190
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3191
 
 
3192
 
    def pull(self, overwrite=False, stop_revision=None,
3193
 
             possible_transports=None, local=False):
3194
 
        """Mirror source into target branch.
3195
 
 
3196
 
        The target branch is considered to be 'local', having low latency.
3197
 
 
3198
 
        :returns: PullResult instance
3199
 
        """
3200
 
        raise NotImplementedError(self.pull)
3201
 
 
3202
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3203
 
                         graph=None):
3204
 
        """Pull in new perfect-fit revisions.
3205
 
 
3206
 
        :param stop_revision: Updated until the given revision
3207
 
        :param overwrite: Always set the branch pointer, rather than checking
3208
 
            to see if it is a proper descendant.
3209
 
        :param graph: A Graph object that can be used to query history
3210
 
            information. This can be None.
3211
 
        :return: None
3212
 
        """
3213
 
        raise NotImplementedError(self.update_revisions)
3214
 
 
3215
 
    def push(self, overwrite=False, stop_revision=None,
3216
 
             _override_hook_source_branch=None):
3217
 
        """Mirror the source branch into the target branch.
3218
 
 
3219
 
        The source branch is considered to be 'local', having low latency.
3220
 
        """
3221
 
        raise NotImplementedError(self.push)
3222
 
 
3223
 
 
3224
 
class GenericInterBranch(InterBranch):
3225
 
    """InterBranch implementation that uses public Branch functions.
3226
 
    """
3227
 
 
3228
 
    @staticmethod
3229
 
    def _get_branch_formats_to_test():
3230
 
        return BranchFormat._default_format, BranchFormat._default_format
3231
 
 
3232
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3233
 
        graph=None):
3234
 
        """See InterBranch.update_revisions()."""
3235
 
        self.source.lock_read()
3236
 
        try:
3237
 
            other_revno, other_last_revision = self.source.last_revision_info()
3238
 
            stop_revno = None # unknown
3239
 
            if stop_revision is None:
3240
 
                stop_revision = other_last_revision
3241
 
                if _mod_revision.is_null(stop_revision):
3242
 
                    # if there are no commits, we're done.
3243
 
                    return
3244
 
                stop_revno = other_revno
3245
 
 
3246
 
            # what's the current last revision, before we fetch [and change it
3247
 
            # possibly]
3248
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3249
 
            # we fetch here so that we don't process data twice in the common
3250
 
            # case of having something to pull, and so that the check for
3251
 
            # already merged can operate on the just fetched graph, which will
3252
 
            # be cached in memory.
3253
 
            self.target.fetch(self.source, stop_revision)
3254
 
            # Check to see if one is an ancestor of the other
3255
 
            if not overwrite:
3256
 
                if graph is None:
3257
 
                    graph = self.target.repository.get_graph()
3258
 
                if self.target._check_if_descendant_or_diverged(
3259
 
                        stop_revision, last_rev, graph, self.source):
3260
 
                    # stop_revision is a descendant of last_rev, but we aren't
3261
 
                    # overwriting, so we're done.
3262
 
                    return
3263
 
            if stop_revno is None:
3264
 
                if graph is None:
3265
 
                    graph = self.target.repository.get_graph()
3266
 
                this_revno, this_last_revision = \
3267
 
                        self.target.last_revision_info()
3268
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3269
 
                                [(other_last_revision, other_revno),
3270
 
                                 (this_last_revision, this_revno)])
3271
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3272
 
        finally:
3273
 
            self.source.unlock()
3274
 
 
3275
 
    def pull(self, overwrite=False, stop_revision=None,
3276
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3277
 
             _override_hook_target=None, local=False):
3278
 
        """See Branch.pull.
3279
 
 
3280
 
        :param _hook_master: Private parameter - set the branch to
3281
 
            be supplied as the master to pull hooks.
3282
 
        :param run_hooks: Private parameter - if false, this branch
3283
 
            is being called because it's the master of the primary branch,
3284
 
            so it should not run its hooks.
3285
 
        :param _override_hook_target: Private parameter - set the branch to be
3286
 
            supplied as the target_branch to pull hooks.
3287
 
        :param local: Only update the local branch, and not the bound branch.
3288
 
        """
3289
 
        # This type of branch can't be bound.
3290
 
        if local:
3291
 
            raise errors.LocalRequiresBoundBranch()
3292
 
        result = PullResult()
3293
 
        result.source_branch = self.source
3294
 
        if _override_hook_target is None:
3295
 
            result.target_branch = self.target
3296
 
        else:
3297
 
            result.target_branch = _override_hook_target
3298
 
        self.source.lock_read()
3299
 
        try:
3300
 
            # We assume that during 'pull' the target repository is closer than
3301
 
            # the source one.
3302
 
            self.source.update_references(self.target)
3303
 
            graph = self.target.repository.get_graph(self.source.repository)
3304
 
            # TODO: Branch formats should have a flag that indicates 
3305
 
            # that revno's are expensive, and pull() should honor that flag.
3306
 
            # -- JRV20090506
3307
 
            result.old_revno, result.old_revid = \
3308
 
                self.target.last_revision_info()
3309
 
            self.target.update_revisions(self.source, stop_revision,
3310
 
                overwrite=overwrite, graph=graph)
3311
 
            # TODO: The old revid should be specified when merging tags, 
3312
 
            # so a tags implementation that versions tags can only 
3313
 
            # pull in the most recent changes. -- JRV20090506
3314
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3315
 
                overwrite)
3316
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3317
 
            if _hook_master:
3318
 
                result.master_branch = _hook_master
3319
 
                result.local_branch = result.target_branch
3320
 
            else:
3321
 
                result.master_branch = result.target_branch
3322
 
                result.local_branch = None
3323
 
            if run_hooks:
3324
 
                for hook in Branch.hooks['post_pull']:
3325
 
                    hook(result)
3326
 
        finally:
3327
 
            self.source.unlock()
3328
 
        return result
3329
 
 
3330
 
    def push(self, overwrite=False, stop_revision=None,
3331
 
             _override_hook_source_branch=None):
3332
 
        """See InterBranch.push.
3333
 
 
3334
 
        This is the basic concrete implementation of push()
3335
 
 
3336
 
        :param _override_hook_source_branch: If specified, run
3337
 
        the hooks passing this Branch as the source, rather than self.
3338
 
        This is for use of RemoteBranch, where push is delegated to the
3339
 
        underlying vfs-based Branch.
3340
 
        """
3341
 
        # TODO: Public option to disable running hooks - should be trivial but
3342
 
        # needs tests.
3343
 
        self.source.lock_read()
3344
 
        try:
3345
 
            return _run_with_write_locked_target(
3346
 
                self.target, self._push_with_bound_branches, overwrite,
3347
 
                stop_revision,
3348
 
                _override_hook_source_branch=_override_hook_source_branch)
3349
 
        finally:
3350
 
            self.source.unlock()
3351
 
 
3352
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3353
 
            _override_hook_source_branch=None):
3354
 
        """Push from source into target, and into target's master if any.
3355
 
        """
3356
 
        def _run_hooks():
3357
 
            if _override_hook_source_branch:
3358
 
                result.source_branch = _override_hook_source_branch
3359
 
            for hook in Branch.hooks['post_push']:
3360
 
                hook(result)
3361
 
 
3362
 
        bound_location = self.target.get_bound_location()
3363
 
        if bound_location and self.target.base != bound_location:
3364
 
            # there is a master branch.
3365
 
            #
3366
 
            # XXX: Why the second check?  Is it even supported for a branch to
3367
 
            # be bound to itself? -- mbp 20070507
3368
 
            master_branch = self.target.get_master_branch()
3369
 
            master_branch.lock_write()
3370
 
            try:
3371
 
                # push into the master from the source branch.
3372
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3373
 
                # and push into the target branch from the source. Note that we
3374
 
                # push from the source branch again, because its considered the
3375
 
                # highest bandwidth repository.
3376
 
                result = self.source._basic_push(self.target, overwrite,
3377
 
                    stop_revision)
3378
 
                result.master_branch = master_branch
3379
 
                result.local_branch = self.target
3380
 
                _run_hooks()
3381
 
                return result
3382
 
            finally:
3383
 
                master_branch.unlock()
3384
 
        else:
3385
 
            # no master branch
3386
 
            result = self.source._basic_push(self.target, overwrite,
3387
 
                stop_revision)
3388
 
            # TODO: Why set master_branch and local_branch if there's no
3389
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3390
 
            # 20070504
3391
 
            result.master_branch = self.target
3392
 
            result.local_branch = None
3393
 
            _run_hooks()
3394
 
            return result
3395
 
 
3396
 
    @classmethod
3397
 
    def is_compatible(self, source, target):
3398
 
        # GenericBranch uses the public API, so always compatible
3399
 
        return True
3400
 
 
3401
 
 
3402
 
class InterToBranch5(GenericInterBranch):
3403
 
 
3404
 
    @staticmethod
3405
 
    def _get_branch_formats_to_test():
3406
 
        return BranchFormat._default_format, BzrBranchFormat5()
3407
 
 
3408
 
    def pull(self, overwrite=False, stop_revision=None,
3409
 
             possible_transports=None, run_hooks=True,
3410
 
             _override_hook_target=None, local=False):
3411
 
        """Pull from source into self, updating my master if any.
3412
 
 
3413
 
        :param run_hooks: Private parameter - if false, this branch
3414
 
            is being called because it's the master of the primary branch,
3415
 
            so it should not run its hooks.
3416
 
        """
3417
 
        bound_location = self.target.get_bound_location()
3418
 
        if local and not bound_location:
3419
 
            raise errors.LocalRequiresBoundBranch()
3420
 
        master_branch = None
3421
 
        if not local and bound_location and self.source.user_url != bound_location:
3422
 
            # not pulling from master, so we need to update master.
3423
 
            master_branch = self.target.get_master_branch(possible_transports)
3424
 
            master_branch.lock_write()
3425
 
        try:
3426
 
            if master_branch:
3427
 
                # pull from source into master.
3428
 
                master_branch.pull(self.source, overwrite, stop_revision,
3429
 
                    run_hooks=False)
3430
 
            return super(InterToBranch5, self).pull(overwrite,
3431
 
                stop_revision, _hook_master=master_branch,
3432
 
                run_hooks=run_hooks,
3433
 
                _override_hook_target=_override_hook_target)
3434
 
        finally:
3435
 
            if master_branch:
3436
 
                master_branch.unlock()
3437
 
 
3438
 
 
3439
 
InterBranch.register_optimiser(GenericInterBranch)
3440
 
InterBranch.register_optimiser(InterToBranch5)