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