~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
 
        symbol_versioning,
36
33
        transport,
37
34
        tsort,
38
35
        ui,
39
36
        urlutils,
40
37
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
38
from bzrlib.config import BranchConfig
 
39
from bzrlib.repofmt.pack_repo import RepositoryFormatPackDevelopment1Subtree
43
40
from bzrlib.tag import (
44
41
    BasicTags,
45
42
    DisabledTags,
47
44
""")
48
45
 
49
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
 
from bzrlib.hooks import HookPoint, Hooks
51
 
from bzrlib.inter import InterObject
52
 
from bzrlib import registry
 
47
from bzrlib.hooks import Hooks
53
48
from bzrlib.symbol_versioning import (
54
49
    deprecated_in,
55
50
    deprecated_method,
86
81
    # - RBC 20060112
87
82
    base = None
88
83
 
 
84
    # override this to set the strategy for storing tags
 
85
    def _make_tags(self):
 
86
        return DisabledTags(self)
 
87
 
89
88
    def __init__(self, *ignored, **ignored_too):
90
 
        self.tags = self._format.make_tags(self)
 
89
        self.tags = self._make_tags()
91
90
        self._revision_history_cache = None
92
91
        self._revision_id_to_revno_cache = None
93
 
        self._partial_revision_id_to_revno_cache = {}
94
 
        self._partial_revision_history_cache = []
95
92
        self._last_revision_info_cache = None
96
 
        self._merge_sorted_revisions_cache = None
97
93
        self._open_hook()
98
 
        hooks = Branch.hooks['open']
99
 
        for hook in hooks:
100
 
            hook(self)
101
94
 
102
95
    def _open_hook(self):
103
96
        """Called by init to allow simpler extension of the base class."""
104
97
 
105
 
    def _activate_fallback_location(self, url):
106
 
        """Activate the branch/repository from url as a fallback repository."""
107
 
        repo = self._get_fallback_repository(url)
108
 
        if repo.has_same_location(self.repository):
109
 
            raise errors.UnstackableLocationError(self.base, url)
110
 
        self.repository.add_fallback_repository(repo)
111
 
 
112
98
    def break_lock(self):
113
99
        """Break a lock if one is present from another instance.
114
100
 
123
109
        if master is not None:
124
110
            master.break_lock()
125
111
 
126
 
    def _check_stackable_repo(self):
127
 
        if not self.repository._format.supports_external_lookups:
128
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
129
 
                self.repository.base)
130
 
 
131
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
 
        """Extend the partial history to include a given index
133
 
 
134
 
        If a stop_index is supplied, stop when that index has been reached.
135
 
        If a stop_revision is supplied, stop when that revision is
136
 
        encountered.  Otherwise, stop when the beginning of history is
137
 
        reached.
138
 
 
139
 
        :param stop_index: The index which should be present.  When it is
140
 
            present, history extension will stop.
141
 
        :param stop_revision: The revision id which should be present.  When
142
 
            it is encountered, history extension will stop.
143
 
        """
144
 
        if len(self._partial_revision_history_cache) == 0:
145
 
            self._partial_revision_history_cache = [self.last_revision()]
146
 
        repository._iter_for_revno(
147
 
            self.repository, self._partial_revision_history_cache,
148
 
            stop_index=stop_index, stop_revision=stop_revision)
149
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
 
            self._partial_revision_history_cache.pop()
151
 
 
152
 
    def _get_check_refs(self):
153
 
        """Get the references needed for check().
154
 
 
155
 
        See bzrlib.check.
156
 
        """
157
 
        revid = self.last_revision()
158
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
159
 
 
160
112
    @staticmethod
161
113
    def open(base, _unsupported=False, possible_transports=None):
162
114
        """Open the branch rooted at base.
177
129
    @staticmethod
178
130
    def open_containing(url, possible_transports=None):
179
131
        """Open an existing branch which contains url.
180
 
 
 
132
        
181
133
        This probes for a branch at url, and searches upwards from there.
182
134
 
183
135
        Basically we keep looking up until we find the control directory or
184
136
        run into the root.  If there isn't one, raises NotBranchError.
185
 
        If there is one and it is either an unrecognised format or an unsupported
 
137
        If there is one and it is either an unrecognised format or an unsupported 
186
138
        format, UnknownFormatError or UnsupportedFormatError are raised.
187
139
        If there is one, it is returned, along with the unused portion of url.
188
140
        """
190
142
                                                         possible_transports)
191
143
        return control.open_branch(), relpath
192
144
 
193
 
    def _push_should_merge_tags(self):
194
 
        """Should _basic_push merge this branch's tags into the target?
195
 
 
196
 
        The default implementation returns False if this branch has no tags,
197
 
        and True the rest of the time.  Subclasses may override this.
198
 
        """
199
 
        return self.supports_tags() and self.tags.get_tag_dict()
200
 
 
201
145
    def get_config(self):
202
146
        return BranchConfig(self)
203
147
 
204
 
    def _get_config(self):
205
 
        """Get the concrete config for just the config in this branch.
206
 
 
207
 
        This is not intended for client use; see Branch.get_config for the
208
 
        public API.
209
 
 
210
 
        Added in 1.14.
211
 
 
212
 
        :return: An object supporting get_option and set_option.
213
 
        """
214
 
        raise NotImplementedError(self._get_config)
215
 
 
216
 
    def _get_fallback_repository(self, url):
217
 
        """Get the repository we fallback to at url."""
218
 
        url = urlutils.join(self.base, url)
219
 
        a_bzrdir = bzrdir.BzrDir.open(url,
220
 
            possible_transports=[self.bzrdir.root_transport])
221
 
        return a_bzrdir.open_branch().repository
222
 
 
223
 
    def _get_tags_bytes(self):
224
 
        """Get the bytes of a serialised tags dict.
225
 
 
226
 
        Note that not all branches support tags, nor do all use the same tags
227
 
        logic: this method is specific to BasicTags. Other tag implementations
228
 
        may use the same method name and behave differently, safely, because
229
 
        of the double-dispatch via
230
 
        format.make_tags->tags_instance->get_tags_dict.
231
 
 
232
 
        :return: The bytes of the tags file.
233
 
        :seealso: Branch._set_tags_bytes.
234
 
        """
235
 
        return self._transport.get_bytes('tags')
236
 
 
237
 
    def _get_nick(self, local=False, possible_transports=None):
238
 
        config = self.get_config()
239
 
        # explicit overrides master, but don't look for master if local is True
240
 
        if not local and not config.has_explicit_nickname():
241
 
            try:
242
 
                master = self.get_master_branch(possible_transports)
243
 
                if master is not None:
244
 
                    # return the master branch value
245
 
                    return master.nick
246
 
            except errors.BzrError, e:
247
 
                # Silently fall back to local implicit nick if the master is
248
 
                # unavailable
249
 
                mutter("Could not connect to bound branch, "
250
 
                    "falling back to local nick.\n " + str(e))
251
 
        return config.get_nickname()
 
148
    def _get_nick(self):
 
149
        return self.get_config().get_nickname()
252
150
 
253
151
    def _set_nick(self, nick):
254
152
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
258
156
    def is_locked(self):
259
157
        raise NotImplementedError(self.is_locked)
260
158
 
261
 
    def _lefthand_history(self, revision_id, last_rev=None,
262
 
                          other_branch=None):
263
 
        if 'evil' in debug.debug_flags:
264
 
            mutter_callsite(4, "_lefthand_history scales with history.")
265
 
        # stop_revision must be a descendant of last_revision
266
 
        graph = self.repository.get_graph()
267
 
        if last_rev is not None:
268
 
            if not graph.is_ancestor(last_rev, revision_id):
269
 
                # our previous tip is not merged into stop_revision
270
 
                raise errors.DivergedBranches(self, other_branch)
271
 
        # make a new revision history from the graph
272
 
        parents_map = graph.get_parent_map([revision_id])
273
 
        if revision_id not in parents_map:
274
 
            raise errors.NoSuchRevision(self, revision_id)
275
 
        current_rev_id = revision_id
276
 
        new_history = []
277
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
278
 
        # Do not include ghosts or graph origin in revision_history
279
 
        while (current_rev_id in parents_map and
280
 
               len(parents_map[current_rev_id]) > 0):
281
 
            check_not_reserved_id(current_rev_id)
282
 
            new_history.append(current_rev_id)
283
 
            current_rev_id = parents_map[current_rev_id][0]
284
 
            parents_map = graph.get_parent_map([current_rev_id])
285
 
        new_history.reverse()
286
 
        return new_history
287
 
 
288
159
    def lock_write(self):
289
160
        raise NotImplementedError(self.lock_write)
290
161
 
302
173
        raise NotImplementedError(self.get_physical_lock_status)
303
174
 
304
175
    @needs_read_lock
305
 
    def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
306
 
        """Return the revision_id for a dotted revno.
307
 
 
308
 
        :param revno: a tuple like (1,) or (1,1,2)
309
 
        :param _cache_reverse: a private parameter enabling storage
310
 
           of the reverse mapping in a top level cache. (This should
311
 
           only be done in selective circumstances as we want to
312
 
           avoid having the mapping cached multiple times.)
313
 
        :return: the revision_id
314
 
        :raises errors.NoSuchRevision: if the revno doesn't exist
315
 
        """
316
 
        rev_id = self._do_dotted_revno_to_revision_id(revno)
317
 
        if _cache_reverse:
318
 
            self._partial_revision_id_to_revno_cache[rev_id] = revno
319
 
        return rev_id
320
 
 
321
 
    def _do_dotted_revno_to_revision_id(self, revno):
322
 
        """Worker function for dotted_revno_to_revision_id.
323
 
 
324
 
        Subclasses should override this if they wish to
325
 
        provide a more efficient implementation.
326
 
        """
327
 
        if len(revno) == 1:
328
 
            return self.get_rev_id(revno[0])
329
 
        revision_id_to_revno = self.get_revision_id_to_revno_map()
330
 
        revision_ids = [revision_id for revision_id, this_revno
331
 
                        in revision_id_to_revno.iteritems()
332
 
                        if revno == this_revno]
333
 
        if len(revision_ids) == 1:
334
 
            return revision_ids[0]
335
 
        else:
336
 
            revno_str = '.'.join(map(str, revno))
337
 
            raise errors.NoSuchRevision(self, revno_str)
338
 
 
339
 
    @needs_read_lock
340
 
    def revision_id_to_dotted_revno(self, revision_id):
341
 
        """Given a revision id, return its dotted revno.
342
 
 
343
 
        :return: a tuple like (1,) or (400,1,3).
344
 
        """
345
 
        return self._do_revision_id_to_dotted_revno(revision_id)
346
 
 
347
 
    def _do_revision_id_to_dotted_revno(self, revision_id):
348
 
        """Worker function for revision_id_to_revno."""
349
 
        # Try the caches if they are loaded
350
 
        result = self._partial_revision_id_to_revno_cache.get(revision_id)
351
 
        if result is not None:
352
 
            return result
353
 
        if self._revision_id_to_revno_cache:
354
 
            result = self._revision_id_to_revno_cache.get(revision_id)
355
 
            if result is None:
356
 
                raise errors.NoSuchRevision(self, revision_id)
357
 
        # Try the mainline as it's optimised
358
 
        try:
359
 
            revno = self.revision_id_to_revno(revision_id)
360
 
            return (revno,)
361
 
        except errors.NoSuchRevision:
362
 
            # We need to load and use the full revno map after all
363
 
            result = self.get_revision_id_to_revno_map().get(revision_id)
364
 
            if result is None:
365
 
                raise errors.NoSuchRevision(self, revision_id)
366
 
        return result
367
 
 
368
 
    @needs_read_lock
369
176
    def get_revision_id_to_revno_map(self):
370
177
        """Return the revision_id => dotted revno map.
371
178
 
395
202
 
396
203
        :return: A dictionary mapping revision_id => dotted revno.
397
204
        """
 
205
        last_revision = self.last_revision()
 
206
        revision_graph = repository._old_get_graph(self.repository,
 
207
            last_revision)
 
208
        merge_sorted_revisions = tsort.merge_sort(
 
209
            revision_graph,
 
210
            last_revision,
 
211
            None,
 
212
            generate_revno=True)
398
213
        revision_id_to_revno = dict((rev_id, revno)
399
 
            for rev_id, depth, revno, end_of_merge
400
 
             in self.iter_merge_sorted_revisions())
 
214
                                    for seq_num, rev_id, depth, revno, end_of_merge
 
215
                                     in merge_sorted_revisions)
401
216
        return revision_id_to_revno
402
217
 
403
 
    @needs_read_lock
404
 
    def iter_merge_sorted_revisions(self, start_revision_id=None,
405
 
            stop_revision_id=None, stop_rule='exclude', direction='reverse'):
406
 
        """Walk the revisions for a branch in merge sorted order.
407
 
 
408
 
        Merge sorted order is the output from a merge-aware,
409
 
        topological sort, i.e. all parents come before their
410
 
        children going forward; the opposite for reverse.
411
 
 
412
 
        :param start_revision_id: the revision_id to begin walking from.
413
 
            If None, the branch tip is used.
414
 
        :param stop_revision_id: the revision_id to terminate the walk
415
 
            after. If None, the rest of history is included.
416
 
        :param stop_rule: if stop_revision_id is not None, the precise rule
417
 
            to use for termination:
418
 
            * 'exclude' - leave the stop revision out of the result (default)
419
 
            * 'include' - the stop revision is the last item in the result
420
 
            * 'with-merges' - include the stop revision and all of its
421
 
              merged revisions in the result
422
 
        :param direction: either 'reverse' or 'forward':
423
 
            * reverse means return the start_revision_id first, i.e.
424
 
              start at the most recent revision and go backwards in history
425
 
            * forward returns tuples in the opposite order to reverse.
426
 
              Note in particular that forward does *not* do any intelligent
427
 
              ordering w.r.t. depth as some clients of this API may like.
428
 
              (If required, that ought to be done at higher layers.)
429
 
 
430
 
        :return: an iterator over (revision_id, depth, revno, end_of_merge)
431
 
            tuples where:
432
 
 
433
 
            * revision_id: the unique id of the revision
434
 
            * depth: How many levels of merging deep this node has been
435
 
              found.
436
 
            * revno_sequence: This field provides a sequence of
437
 
              revision numbers for all revisions. The format is:
438
 
              (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
439
 
              branch that the revno is on. From left to right the REVNO numbers
440
 
              are the sequence numbers within that branch of the revision.
441
 
            * end_of_merge: When True the next node (earlier in history) is
442
 
              part of a different merge.
443
 
        """
444
 
        # Note: depth and revno values are in the context of the branch so
445
 
        # we need the full graph to get stable numbers, regardless of the
446
 
        # start_revision_id.
447
 
        if self._merge_sorted_revisions_cache is None:
448
 
            last_revision = self.last_revision()
449
 
            graph = self.repository.get_graph()
450
 
            parent_map = dict(((key, value) for key, value in
451
 
                     graph.iter_ancestry([last_revision]) if value is not None))
452
 
            revision_graph = repository._strip_NULL_ghosts(parent_map)
453
 
            revs = tsort.merge_sort(revision_graph, last_revision, None,
454
 
                generate_revno=True)
455
 
            # Drop the sequence # before caching
456
 
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
457
 
 
458
 
        filtered = self._filter_merge_sorted_revisions(
459
 
            self._merge_sorted_revisions_cache, start_revision_id,
460
 
            stop_revision_id, stop_rule)
461
 
        if direction == 'reverse':
462
 
            return filtered
463
 
        if direction == 'forward':
464
 
            return reversed(list(filtered))
465
 
        else:
466
 
            raise ValueError('invalid direction %r' % direction)
467
 
 
468
 
    def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
469
 
        start_revision_id, stop_revision_id, stop_rule):
470
 
        """Iterate over an inclusive range of sorted revisions."""
471
 
        rev_iter = iter(merge_sorted_revisions)
472
 
        if start_revision_id is not None:
473
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
474
 
                if rev_id != start_revision_id:
475
 
                    continue
476
 
                else:
477
 
                    # The decision to include the start or not
478
 
                    # depends on the stop_rule if a stop is provided
479
 
                    rev_iter = chain(
480
 
                        iter([(rev_id, depth, revno, end_of_merge)]),
481
 
                        rev_iter)
482
 
                    break
483
 
        if stop_revision_id is None:
484
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
485
 
                yield rev_id, depth, revno, end_of_merge
486
 
        elif stop_rule == 'exclude':
487
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
488
 
                if rev_id == stop_revision_id:
489
 
                    return
490
 
                yield rev_id, depth, revno, end_of_merge
491
 
        elif stop_rule == 'include':
492
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
493
 
                yield rev_id, depth, revno, end_of_merge
494
 
                if rev_id == stop_revision_id:
495
 
                    return
496
 
        elif stop_rule == 'with-merges':
497
 
            stop_rev = self.repository.get_revision(stop_revision_id)
498
 
            if stop_rev.parent_ids:
499
 
                left_parent = stop_rev.parent_ids[0]
500
 
            else:
501
 
                left_parent = _mod_revision.NULL_REVISION
502
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
503
 
                if rev_id == left_parent:
504
 
                    return
505
 
                yield rev_id, depth, revno, end_of_merge
506
 
        else:
507
 
            raise ValueError('invalid stop_rule %r' % stop_rule)
508
 
 
509
218
    def leave_lock_in_place(self):
510
219
        """Tell this branch object not to release the physical lock when this
511
220
        object is unlocked.
512
 
 
 
221
        
513
222
        If lock_write doesn't return a token, then this method is not supported.
514
223
        """
515
224
        self.control_files.leave_in_place()
530
239
        """
531
240
        raise errors.UpgradeRequired(self.base)
532
241
 
533
 
    def set_append_revisions_only(self, enabled):
534
 
        if not self._format.supports_set_append_revisions_only():
535
 
            raise errors.UpgradeRequired(self.base)
536
 
        if enabled:
537
 
            value = 'True'
538
 
        else:
539
 
            value = 'False'
540
 
        self.get_config().set_user_option('append_revisions_only', value,
541
 
            warn_masked=True)
542
 
 
543
 
    def set_reference_info(self, file_id, tree_path, branch_location):
544
 
        """Set the branch location to use for a tree reference."""
545
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
546
 
 
547
 
    def get_reference_info(self, file_id):
548
 
        """Get the tree_path and branch_location for a tree reference."""
549
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
550
 
 
551
242
    @needs_write_lock
552
243
    def fetch(self, from_branch, last_revision=None, pb=None):
553
244
        """Copy revisions from from_branch into this branch.
556
247
        :param last_revision: What revision to stop at (None for at the end
557
248
                              of the branch.
558
249
        :param pb: An optional progress bar to use.
559
 
        :return: None
 
250
 
 
251
        Returns the copied revision count and the failed revisions in a tuple:
 
252
        (copied, failures).
560
253
        """
561
254
        if self.base == from_branch.base:
562
255
            return (0, [])
563
 
        if pb is not None:
564
 
            symbol_versioning.warn(
565
 
                symbol_versioning.deprecated_in((1, 14, 0))
566
 
                % "pb parameter to fetch()")
 
256
        if pb is None:
 
257
            nested_pb = ui.ui_factory.nested_progress_bar()
 
258
            pb = nested_pb
 
259
        else:
 
260
            nested_pb = None
 
261
 
567
262
        from_branch.lock_read()
568
263
        try:
569
264
            if last_revision is None:
 
265
                pb.update('get source history')
570
266
                last_revision = from_branch.last_revision()
571
267
                last_revision = _mod_revision.ensure_null(last_revision)
572
268
            return self.repository.fetch(from_branch.repository,
573
269
                                         revision_id=last_revision,
574
 
                                         pb=pb)
 
270
                                         pb=nested_pb)
575
271
        finally:
 
272
            if nested_pb is not None:
 
273
                nested_pb.finished()
576
274
            from_branch.unlock()
577
275
 
578
276
    def get_bound_location(self):
582
280
        branch.
583
281
        """
584
282
        return None
585
 
 
 
283
    
586
284
    def get_old_bound_location(self):
587
285
        """Return the URL of the branch we used to be bound to
588
286
        """
589
287
        raise errors.UpgradeRequired(self.base)
590
288
 
591
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
592
 
                           timezone=None, committer=None, revprops=None,
 
289
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
290
                           timezone=None, committer=None, revprops=None, 
593
291
                           revision_id=None):
594
292
        """Obtain a CommitBuilder for this branch.
595
 
 
 
293
        
596
294
        :param parents: Revision ids of the parents of the new revision.
597
295
        :param config: Optional configuration to use.
598
296
        :param timestamp: Optional timestamp recorded for commit.
604
302
 
605
303
        if config is None:
606
304
            config = self.get_config()
607
 
 
 
305
        
608
306
        return self.repository.get_commit_builder(self, parents, config,
609
307
            timestamp, timezone, committer, revprops, revision_id)
610
308
 
611
309
    def get_master_branch(self, possible_transports=None):
612
310
        """Return the branch we are bound to.
613
 
 
 
311
        
614
312
        :return: Either a Branch, or None
615
313
        """
616
314
        return None
642
340
    def set_revision_history(self, rev_history):
643
341
        raise NotImplementedError(self.set_revision_history)
644
342
 
645
 
    @needs_write_lock
646
 
    def set_parent(self, url):
647
 
        """See Branch.set_parent."""
648
 
        # TODO: Maybe delete old location files?
649
 
        # URLs should never be unicode, even on the local fs,
650
 
        # FIXUP this and get_parent in a future branch format bump:
651
 
        # read and rewrite the file. RBC 20060125
652
 
        if url is not None:
653
 
            if isinstance(url, unicode):
654
 
                try:
655
 
                    url = url.encode('ascii')
656
 
                except UnicodeEncodeError:
657
 
                    raise errors.InvalidURL(url,
658
 
                        "Urls must be 7-bit ascii, "
659
 
                        "use bzrlib.urlutils.escape")
660
 
            url = urlutils.relative_url(self.base, url)
661
 
        self._set_parent_location(url)
662
 
 
663
 
    @needs_write_lock
664
343
    def set_stacked_on_url(self, url):
665
344
        """Set the URL this branch is stacked against.
666
345
 
669
348
        :raises UnstackableRepositoryFormat: If the repository does not support
670
349
            stacking.
671
350
        """
672
 
        if not self._format.supports_stacking():
673
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
674
 
        # XXX: Changing from one fallback repository to another does not check
675
 
        # that all the data you need is present in the new fallback.
676
 
        # Possibly it should.
677
 
        self._check_stackable_repo()
678
 
        if not url:
679
 
            try:
680
 
                old_url = self.get_stacked_on_url()
681
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
682
 
                errors.UnstackableRepositoryFormat):
683
 
                return
684
 
            self._unstack()
685
 
        else:
686
 
            self._activate_fallback_location(url)
687
 
        # write this out after the repository is stacked to avoid setting a
688
 
        # stacked config that doesn't work.
689
 
        self._set_config_location('stacked_on_location', url)
690
 
 
691
 
    def _unstack(self):
692
 
        """Change a branch to be unstacked, copying data as needed.
693
 
        
694
 
        Don't call this directly, use set_stacked_on_url(None).
695
 
        """
696
 
        pb = ui.ui_factory.nested_progress_bar()
697
 
        try:
698
 
            pb.update("Unstacking")
699
 
            # The basic approach here is to fetch the tip of the branch,
700
 
            # including all available ghosts, from the existing stacked
701
 
            # repository into a new repository object without the fallbacks. 
702
 
            #
703
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
704
 
            # correct for CHKMap repostiories
705
 
            old_repository = self.repository
706
 
            if len(old_repository._fallback_repositories) != 1:
707
 
                raise AssertionError("can't cope with fallback repositories "
708
 
                    "of %r" % (self.repository,))
709
 
            # unlock it, including unlocking the fallback
710
 
            old_repository.unlock()
711
 
            old_repository.lock_read()
712
 
            try:
713
 
                # Repositories don't offer an interface to remove fallback
714
 
                # repositories today; take the conceptually simpler option and just
715
 
                # reopen it.  We reopen it starting from the URL so that we
716
 
                # get a separate connection for RemoteRepositories and can
717
 
                # stream from one of them to the other.  This does mean doing
718
 
                # separate SSH connection setup, but unstacking is not a
719
 
                # common operation so it's tolerable.
720
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
721
 
                new_repository = new_bzrdir.find_repository()
722
 
                self.repository = new_repository
723
 
                if self.repository._fallback_repositories:
724
 
                    raise AssertionError("didn't expect %r to have "
725
 
                        "fallback_repositories"
726
 
                        % (self.repository,))
727
 
                # this is not paired with an unlock because it's just restoring
728
 
                # the previous state; the lock's released when set_stacked_on_url
729
 
                # returns
730
 
                self.repository.lock_write()
731
 
                # XXX: If you unstack a branch while it has a working tree
732
 
                # with a pending merge, the pending-merged revisions will no
733
 
                # longer be present.  You can (probably) revert and remerge.
734
 
                #
735
 
                # XXX: This only fetches up to the tip of the repository; it
736
 
                # doesn't bring across any tags.  That's fairly consistent
737
 
                # with how branch works, but perhaps not ideal.
738
 
                self.repository.fetch(old_repository,
739
 
                    revision_id=self.last_revision(),
740
 
                    find_ghosts=True)
741
 
            finally:
742
 
                old_repository.unlock()
743
 
        finally:
744
 
            pb.finished()
745
 
 
746
 
    def _set_tags_bytes(self, bytes):
747
 
        """Mirror method for _get_tags_bytes.
748
 
 
749
 
        :seealso: Branch._get_tags_bytes.
750
 
        """
751
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
752
 
            'tags', bytes)
 
351
        raise NotImplementedError(self.set_stacked_on_url)
753
352
 
754
353
    def _cache_revision_history(self, rev_history):
755
354
        """Set the cached revision history to rev_history.
782
381
        self._revision_history_cache = None
783
382
        self._revision_id_to_revno_cache = None
784
383
        self._last_revision_info_cache = None
785
 
        self._merge_sorted_revisions_cache = None
786
 
        self._partial_revision_history_cache = []
787
 
        self._partial_revision_id_to_revno_cache = {}
788
384
 
789
385
    def _gen_revision_history(self):
790
386
        """Return sequence of revision hashes on to this branch.
791
 
 
 
387
        
792
388
        Unlike revision_history, this method always regenerates or rereads the
793
389
        revision history, i.e. it does not cache the result, so repeated calls
794
390
        may be expensive.
795
391
 
796
392
        Concrete subclasses should override this instead of revision_history so
797
393
        that subclasses do not need to deal with caching logic.
798
 
 
 
394
        
799
395
        This API is semi-public; it only for use by subclasses, all other code
800
396
        should consider it to be private.
801
397
        """
804
400
    @needs_read_lock
805
401
    def revision_history(self):
806
402
        """Return sequence of revision ids on this branch.
807
 
 
 
403
        
808
404
        This method will cache the revision history for as long as it is safe to
809
405
        do so.
810
406
        """
829
425
        """Older format branches cannot bind or unbind."""
830
426
        raise errors.UpgradeRequired(self.base)
831
427
 
 
428
    def set_append_revisions_only(self, enabled):
 
429
        """Older format branches are never restricted to append-only"""
 
430
        raise errors.UpgradeRequired(self.base)
 
431
 
832
432
    def last_revision(self):
833
433
        """Return last revision id, or NULL_REVISION."""
834
434
        return self.last_revision_info()[1]
854
454
    @deprecated_method(deprecated_in((1, 6, 0)))
855
455
    def missing_revisions(self, other, stop_revision=None):
856
456
        """Return a list of new revisions that would perfectly fit.
857
 
 
 
457
        
858
458
        If self and other have not diverged, return a list of the revisions
859
459
        present in other, but missing from self.
860
460
        """
887
487
            information. This can be None.
888
488
        :return: None
889
489
        """
890
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
891
 
            overwrite, graph)
892
 
 
893
 
    def import_last_revision_info(self, source_repo, revno, revid):
894
 
        """Set the last revision info, importing from another repo if necessary.
895
 
 
896
 
        This is used by the bound branch code to upload a revision to
897
 
        the master branch first before updating the tip of the local branch.
898
 
 
899
 
        :param source_repo: Source repository to optionally fetch from
900
 
        :param revno: Revision number of the new tip
901
 
        :param revid: Revision id of the new tip
902
 
        """
903
 
        if not self.repository.has_same_location(source_repo):
904
 
            self.repository.fetch(source_repo, revision_id=revid)
905
 
        self.set_last_revision_info(revno, revid)
 
490
        other.lock_read()
 
491
        try:
 
492
            other_revno, other_last_revision = other.last_revision_info()
 
493
            stop_revno = None # unknown
 
494
            if stop_revision is None:
 
495
                stop_revision = other_last_revision
 
496
                if _mod_revision.is_null(stop_revision):
 
497
                    # if there are no commits, we're done.
 
498
                    return
 
499
                stop_revno = other_revno
 
500
 
 
501
            # what's the current last revision, before we fetch [and change it
 
502
            # possibly]
 
503
            last_rev = _mod_revision.ensure_null(self.last_revision())
 
504
            # we fetch here so that we don't process data twice in the common
 
505
            # case of having something to pull, and so that the check for 
 
506
            # already merged can operate on the just fetched graph, which will
 
507
            # be cached in memory.
 
508
            self.fetch(other, stop_revision)
 
509
            # Check to see if one is an ancestor of the other
 
510
            if not overwrite:
 
511
                if graph is None:
 
512
                    graph = self.repository.get_graph()
 
513
                if self._check_if_descendant_or_diverged(
 
514
                        stop_revision, last_rev, graph, other):
 
515
                    # stop_revision is a descendant of last_rev, but we aren't
 
516
                    # overwriting, so we're done.
 
517
                    return
 
518
            if stop_revno is None:
 
519
                if graph is None:
 
520
                    graph = self.repository.get_graph()
 
521
                this_revno, this_last_revision = self.last_revision_info()
 
522
                stop_revno = graph.find_distance_to_null(stop_revision,
 
523
                                [(other_last_revision, other_revno),
 
524
                                 (this_last_revision, this_revno)])
 
525
            self.set_last_revision_info(stop_revno, stop_revision)
 
526
        finally:
 
527
            other.unlock()
906
528
 
907
529
    def revision_id_to_revno(self, revision_id):
908
530
        """Given a revision id, return its revno"""
914
536
        except ValueError:
915
537
            raise errors.NoSuchRevision(self, revision_id)
916
538
 
917
 
    @needs_read_lock
918
539
    def get_rev_id(self, revno, history=None):
919
540
        """Find the revision id of the specified revno."""
920
541
        if revno == 0:
921
542
            return _mod_revision.NULL_REVISION
922
 
        last_revno, last_revid = self.last_revision_info()
923
 
        if revno == last_revno:
924
 
            return last_revid
925
 
        if revno <= 0 or revno > last_revno:
 
543
        if history is None:
 
544
            history = self.revision_history()
 
545
        if revno <= 0 or revno > len(history):
926
546
            raise errors.NoSuchRevision(self, revno)
927
 
        distance_from_last = last_revno - revno
928
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
929
 
            self._extend_partial_history(distance_from_last)
930
 
        return self._partial_revision_history_cache[distance_from_last]
 
547
        return history[revno - 1]
931
548
 
932
 
    @needs_write_lock
933
549
    def pull(self, source, overwrite=False, stop_revision=None,
934
 
             possible_transports=None, *args, **kwargs):
 
550
             possible_transports=None, _override_hook_target=None):
935
551
        """Mirror source into this branch.
936
552
 
937
553
        This branch is considered to be 'local', having low latency.
938
554
 
939
555
        :returns: PullResult instance
940
556
        """
941
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
942
 
            stop_revision=stop_revision,
943
 
            possible_transports=possible_transports, *args, **kwargs)
 
557
        raise NotImplementedError(self.pull)
944
558
 
945
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
946
 
        **kwargs):
 
559
    def push(self, target, overwrite=False, stop_revision=None):
947
560
        """Mirror this branch into target.
948
561
 
949
562
        This branch is considered to be 'local', having low latency.
950
563
        """
951
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
952
 
            *args, **kwargs)
953
 
 
954
 
    def lossy_push(self, target, stop_revision=None):
955
 
        """Push deltas into another branch.
956
 
 
957
 
        :note: This does not, like push, retain the revision ids from 
958
 
            the source branch and will, rather than adding bzr-specific 
959
 
            metadata, push only those semantics of the revision that can be 
960
 
            natively represented by this branch' VCS.
961
 
 
962
 
        :param target: Target branch
963
 
        :param stop_revision: Revision to push, defaults to last revision.
964
 
        :return: BranchPushResult with an extra member revidmap: 
965
 
            A dictionary mapping revision ids from the target branch 
966
 
            to new revision ids in the target branch, for each 
967
 
            revision that was pushed.
968
 
        """
969
 
        inter = InterBranch.get(self, target)
970
 
        lossy_push = getattr(inter, "lossy_push", None)
971
 
        if lossy_push is None:
972
 
            raise errors.LossyPushToSameVCS(self, target)
973
 
        return lossy_push(stop_revision)
 
564
        raise NotImplementedError(self.push)
974
565
 
975
566
    def basis_tree(self):
976
567
        """Return `Tree` object for last revision."""
979
570
    def get_parent(self):
980
571
        """Return the parent location of the branch.
981
572
 
982
 
        This is the default location for pull/missing.  The usual
 
573
        This is the default location for push/pull/missing.  The usual
983
574
        pattern is that the user can override it by specifying a
984
575
        location.
985
576
        """
986
 
        parent = self._get_parent_location()
987
 
        if parent is None:
988
 
            return parent
989
 
        # This is an old-format absolute path to a local branch
990
 
        # turn it into a url
991
 
        if parent.startswith('/'):
992
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
993
 
        try:
994
 
            return urlutils.join(self.base[:-1], parent)
995
 
        except errors.InvalidURLJoin, e:
996
 
            raise errors.InaccessibleParent(parent, self.base)
997
 
 
998
 
    def _get_parent_location(self):
999
 
        raise NotImplementedError(self._get_parent_location)
 
577
        raise NotImplementedError(self.get_parent)
1000
578
 
1001
579
    def _set_config_location(self, name, url, config=None,
1002
580
                             make_relative=False):
1016
594
            location = None
1017
595
        return location
1018
596
 
1019
 
    def get_child_submit_format(self):
1020
 
        """Return the preferred format of submissions to this branch."""
1021
 
        return self.get_config().get_user_option("child_submit_format")
1022
 
 
1023
597
    def get_submit_branch(self):
1024
598
        """Return the submit location of the branch.
1025
599
 
1042
616
    def get_public_branch(self):
1043
617
        """Return the public location of the branch.
1044
618
 
1045
 
        This is used by merge directives.
 
619
        This is is used by merge directives.
1046
620
        """
1047
621
        return self._get_config_location('public_branch')
1048
622
 
1064
638
        """Set a new push location for this branch."""
1065
639
        raise NotImplementedError(self.set_push_location)
1066
640
 
1067
 
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1068
 
        """Run the post_change_branch_tip hooks."""
1069
 
        hooks = Branch.hooks['post_change_branch_tip']
1070
 
        if not hooks:
1071
 
            return
1072
 
        new_revno, new_revid = self.last_revision_info()
1073
 
        params = ChangeBranchTipParams(
1074
 
            self, old_revno, new_revno, old_revid, new_revid)
1075
 
        for hook in hooks:
1076
 
            hook(params)
1077
 
 
1078
 
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1079
 
        """Run the pre_change_branch_tip hooks."""
1080
 
        hooks = Branch.hooks['pre_change_branch_tip']
1081
 
        if not hooks:
1082
 
            return
1083
 
        old_revno, old_revid = self.last_revision_info()
1084
 
        params = ChangeBranchTipParams(
1085
 
            self, old_revno, new_revno, old_revid, new_revid)
1086
 
        for hook in hooks:
1087
 
            try:
1088
 
                hook(params)
1089
 
            except errors.TipChangeRejected:
1090
 
                raise
1091
 
            except Exception:
1092
 
                exc_info = sys.exc_info()
1093
 
                hook_name = Branch.hooks.get_hook_name(hook)
1094
 
                raise errors.HookFailed(
1095
 
                    'pre_change_branch_tip', hook_name, exc_info)
 
641
    def set_parent(self, url):
 
642
        raise NotImplementedError(self.set_parent)
1096
643
 
1097
644
    @needs_write_lock
1098
645
    def update(self):
1099
 
        """Synchronise this branch with the master branch if any.
 
646
        """Synchronise this branch with the master branch if any. 
1100
647
 
1101
648
        :return: None or the last_revision pivoted out during the update.
1102
649
        """
1109
656
        """
1110
657
        if revno != 0:
1111
658
            self.check_real_revno(revno)
1112
 
 
 
659
            
1113
660
    def check_real_revno(self, revno):
1114
661
        """\
1115
662
        Check whether a revno corresponds to a real revision.
1119
666
            raise errors.InvalidRevisionNumber(revno)
1120
667
 
1121
668
    @needs_read_lock
1122
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
669
    def clone(self, to_bzrdir, revision_id=None):
1123
670
        """Clone this branch into to_bzrdir preserving all semantic values.
1124
 
 
1125
 
        Most API users will want 'create_clone_on_transport', which creates a
1126
 
        new bzrdir and branch on the fly.
1127
 
 
 
671
        
1128
672
        revision_id: if not None, the revision history in the new branch will
1129
673
                     be truncated to end with revision_id.
1130
674
        """
1131
675
        result = to_bzrdir.create_branch()
1132
 
        result.lock_write()
1133
 
        try:
1134
 
            if repository_policy is not None:
1135
 
                repository_policy.configure_branch(result)
1136
 
            self.copy_content_into(result, revision_id=revision_id)
1137
 
        finally:
1138
 
            result.unlock()
1139
 
        return result
 
676
        self.copy_content_into(result, revision_id=revision_id)
 
677
        return  result
1140
678
 
1141
679
    @needs_read_lock
1142
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
680
    def sprout(self, to_bzrdir, revision_id=None):
1143
681
        """Create a new line of development from the branch, into to_bzrdir.
1144
682
 
1145
683
        to_bzrdir controls the branch format.
1148
686
                     be truncated to end with revision_id.
1149
687
        """
1150
688
        result = to_bzrdir.create_branch()
1151
 
        result.lock_write()
1152
 
        try:
1153
 
            if repository_policy is not None:
1154
 
                repository_policy.configure_branch(result)
1155
 
            self.copy_content_into(result, revision_id=revision_id)
1156
 
            result.set_parent(self.bzrdir.root_transport.base)
1157
 
        finally:
1158
 
            result.unlock()
 
689
        self.copy_content_into(result, revision_id=revision_id)
 
690
        result.set_parent(self.bzrdir.root_transport.base)
1159
691
        return result
1160
692
 
1161
693
    def _synchronize_history(self, destination, revision_id):
1162
694
        """Synchronize last revision and revision history between branches.
1163
695
 
1164
696
        This version is most efficient when the destination is also a
1165
 
        BzrBranch6, but works for BzrBranch5, as long as the destination's
1166
 
        repository contains all the lefthand ancestors of the intended
1167
 
        last_revision.  If not, set_last_revision_info will fail.
 
697
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
698
        history is the true lefthand parent history, and all of the revisions
 
699
        are in the destination's repository.  If not, set_revision_history
 
700
        will fail.
1168
701
 
1169
702
        :param destination: The branch to copy the history into
1170
703
        :param revision_id: The revision-id to truncate history at.  May
1171
704
          be None to copy complete history.
1172
705
        """
1173
 
        source_revno, source_revision_id = self.last_revision_info()
1174
 
        if revision_id is None:
1175
 
            revno, revision_id = source_revno, source_revision_id
 
706
        if revision_id == _mod_revision.NULL_REVISION:
 
707
            new_history = []
1176
708
        else:
1177
 
            graph = self.repository.get_graph()
 
709
            new_history = self.revision_history()
 
710
        if revision_id is not None and new_history != []:
1178
711
            try:
1179
 
                revno = graph.find_distance_to_null(revision_id, 
1180
 
                    [(source_revision_id, source_revno)])
1181
 
            except errors.GhostRevisionsHaveNoRevno:
1182
 
                # Default to 1, if we can't find anything else
1183
 
                revno = 1
1184
 
        destination.set_last_revision_info(revno, revision_id)
 
712
                new_history = new_history[:new_history.index(revision_id) + 1]
 
713
            except ValueError:
 
714
                rev = self.repository.get_revision(revision_id)
 
715
                new_history = rev.get_history(self.repository)[1:]
 
716
        destination.set_revision_history(new_history)
1185
717
 
1186
718
    @needs_read_lock
1187
719
    def copy_content_into(self, destination, revision_id=None):
1190
722
        revision_id: if not None, the revision history in the new branch will
1191
723
                     be truncated to end with revision_id.
1192
724
        """
1193
 
        self.update_references(destination)
1194
725
        self._synchronize_history(destination, revision_id)
1195
726
        try:
1196
727
            parent = self.get_parent()
1199
730
        else:
1200
731
            if parent:
1201
732
                destination.set_parent(parent)
1202
 
        if self._push_should_merge_tags():
1203
 
            self.tags.merge_to(destination.tags)
1204
 
 
1205
 
    def update_references(self, target):
1206
 
        if not getattr(self._format, 'supports_reference_locations', False):
1207
 
            return
1208
 
        reference_dict = self._get_all_reference_info()
1209
 
        if len(reference_dict) == 0:
1210
 
            return
1211
 
        old_base = self.base
1212
 
        new_base = target.base
1213
 
        target_reference_dict = target._get_all_reference_info()
1214
 
        for file_id, (tree_path, branch_location) in (
1215
 
            reference_dict.items()):
1216
 
            branch_location = urlutils.rebase_url(branch_location,
1217
 
                                                  old_base, new_base)
1218
 
            target_reference_dict.setdefault(
1219
 
                file_id, (tree_path, branch_location))
1220
 
        target._set_all_reference_info(target_reference_dict)
 
733
        self.tags.merge_to(destination.tags)
1221
734
 
1222
735
    @needs_read_lock
1223
 
    def check(self, refs):
 
736
    def check(self):
1224
737
        """Check consistency of the branch.
1225
738
 
1226
739
        In particular this checks that revisions given in the revision-history
1227
 
        do actually match up in the revision graph, and that they're all
 
740
        do actually match up in the revision graph, and that they're all 
1228
741
        present in the repository.
1229
 
 
 
742
        
1230
743
        Callers will typically also want to check the repository.
1231
744
 
1232
 
        :param refs: Calculated refs for this branch as specified by
1233
 
            branch._get_check_refs()
1234
745
        :return: A BranchCheckResult.
1235
746
        """
1236
 
        result = BranchCheckResult(self)
 
747
        mainline_parent_id = None
1237
748
        last_revno, last_revision_id = self.last_revision_info()
1238
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1239
 
        if actual_revno != last_revno:
1240
 
            result.errors.append(errors.BzrCheckError(
1241
 
                'revno does not match len(mainline) %s != %s' % (
1242
 
                last_revno, actual_revno)))
1243
 
        # TODO: We should probably also check that self.revision_history
1244
 
        # matches the repository for older branch formats.
1245
 
        # If looking for the code that cross-checks repository parents against
1246
 
        # the iter_reverse_revision_history output, that is now a repository
1247
 
        # specific check.
1248
 
        return result
 
749
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
750
                                last_revision_id))
 
751
        real_rev_history.reverse()
 
752
        if len(real_rev_history) != last_revno:
 
753
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
754
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
755
        # TODO: We should probably also check that real_rev_history actually
 
756
        #       matches self.revision_history()
 
757
        for revision_id in real_rev_history:
 
758
            try:
 
759
                revision = self.repository.get_revision(revision_id)
 
760
            except errors.NoSuchRevision, e:
 
761
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
762
                            % revision_id)
 
763
            # In general the first entry on the revision history has no parents.
 
764
            # But it's not illegal for it to have parents listed; this can happen
 
765
            # in imports from Arch when the parents weren't reachable.
 
766
            if mainline_parent_id is not None:
 
767
                if mainline_parent_id not in revision.parent_ids:
 
768
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
769
                                        "parents of {%s}"
 
770
                                        % (mainline_parent_id, revision_id))
 
771
            mainline_parent_id = revision_id
 
772
        return BranchCheckResult(self)
1249
773
 
1250
774
    def _get_checkout_format(self):
1251
775
        """Return the most suitable metadir for a checkout of this branch.
1260
784
            format.set_branch_format(self._format)
1261
785
        return format
1262
786
 
1263
 
    def create_clone_on_transport(self, to_transport, revision_id=None,
1264
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1265
 
        """Create a clone of this branch and its bzrdir.
1266
 
 
1267
 
        :param to_transport: The transport to clone onto.
1268
 
        :param revision_id: The revision id to use as tip in the new branch.
1269
 
            If None the tip is obtained from this branch.
1270
 
        :param stacked_on: An optional URL to stack the clone on.
1271
 
        :param create_prefix: Create any missing directories leading up to
1272
 
            to_transport.
1273
 
        :param use_existing_dir: Use an existing directory if one exists.
1274
 
        """
1275
 
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1276
 
        # clone call. Or something. 20090224 RBC/spiv.
1277
 
        if revision_id is None:
1278
 
            revision_id = self.last_revision()
1279
 
        try:
1280
 
            dir_to = self.bzrdir.clone_on_transport(to_transport,
1281
 
                revision_id=revision_id, stacked_on=stacked_on,
1282
 
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1283
 
        except errors.FileExists:
1284
 
            if not use_existing_dir:
1285
 
                raise
1286
 
        except errors.NoSuchFile:
1287
 
            if not create_prefix:
1288
 
                raise
1289
 
        return dir_to.open_branch()
1290
 
 
1291
787
    def create_checkout(self, to_location, revision_id=None,
1292
788
                        lightweight=False, accelerator_tree=None,
1293
789
                        hardlink=False):
1294
790
        """Create a checkout of a branch.
1295
 
 
 
791
        
1296
792
        :param to_location: The url to produce the checkout at
1297
793
        :param revision_id: The revision to check out
1298
794
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1317
813
                to_location, force_new_tree=False, format=format)
1318
814
            checkout = checkout_branch.bzrdir
1319
815
            checkout_branch.bind(self)
1320
 
            # pull up to the specified revision_id to set the initial
 
816
            # pull up to the specified revision_id to set the initial 
1321
817
            # branch tip correctly, and seed it with history.
1322
818
            checkout_branch.pull(self, stop_revision=revision_id)
1323
819
            from_branch=None
1345
841
        reconciler.reconcile()
1346
842
        return reconciler
1347
843
 
1348
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
844
    def reference_parent(self, file_id, path):
1349
845
        """Return the parent branch for a tree-reference file_id
1350
846
        :param file_id: The file_id of the tree reference
1351
847
        :param path: The path of the file_id in the tree
1352
848
        :return: A branch associated with the file_id
1353
849
        """
1354
850
        # FIXME should provide multiple branches, based on config
1355
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1356
 
                           possible_transports=possible_transports)
 
851
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1357
852
 
1358
853
    def supports_tags(self):
1359
854
        return self._format.supports_tags()
1363
858
        """Ensure that revision_b is a descendant of revision_a.
1364
859
 
1365
860
        This is a helper function for update_revisions.
1366
 
 
 
861
        
1367
862
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1368
863
        :returns: True if revision_b is a descendant of revision_a.
1369
864
        """
1379
874
 
1380
875
    def _revision_relations(self, revision_a, revision_b, graph):
1381
876
        """Determine the relationship between two revisions.
1382
 
 
 
877
        
1383
878
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1384
879
        """
1385
880
        heads = graph.heads([revision_a, revision_b])
1402
897
     * a format string,
1403
898
     * an open routine.
1404
899
 
1405
 
    Formats are placed in an dict by their format string for reference
 
900
    Formats are placed in an dict by their format string for reference 
1406
901
    during branch opening. Its not required that these be instances, they
1407
 
    can be classes themselves with class methods - it simply depends on
 
902
    can be classes themselves with class methods - it simply depends on 
1408
903
    whether state is needed for a given format or not.
1409
904
 
1410
905
    Once a format is deprecated, just deprecate the initialize and open
1411
 
    methods on the format class. Do not deprecate the object, as the
 
906
    methods on the format class. Do not deprecate the object, as the 
1412
907
    object will be created every time regardless.
1413
908
    """
1414
909
 
1418
913
    _formats = {}
1419
914
    """The known formats."""
1420
915
 
1421
 
    can_set_append_revisions_only = True
1422
 
 
1423
916
    def __eq__(self, other):
1424
917
        return self.__class__ is other.__class__
1425
918
 
1498
991
        control_files = lockable_files.LockableFiles(branch_transport,
1499
992
            lock_name, lock_class)
1500
993
        control_files.create_lock()
1501
 
        try:
1502
 
            control_files.lock_write()
1503
 
        except errors.LockContention:
1504
 
            if lock_type != 'branch4':
1505
 
                raise
1506
 
            lock_taken = False
1507
 
        else:
1508
 
            lock_taken = True
 
994
        control_files.lock_write()
1509
995
        if set_format:
1510
996
            utf8_files += [('format', self.get_format_string())]
1511
997
        try:
1514
1000
                    filename, content,
1515
1001
                    mode=a_bzrdir._get_file_mode())
1516
1002
        finally:
1517
 
            if lock_taken:
1518
 
                control_files.unlock()
 
1003
            control_files.unlock()
1519
1004
        return self.open(a_bzrdir, _found=True)
1520
1005
 
1521
1006
    def initialize(self, a_bzrdir):
1526
1011
        """Is this format supported?
1527
1012
 
1528
1013
        Supported formats can be initialized and opened.
1529
 
        Unsupported formats may not support initialization or committing or
 
1014
        Unsupported formats may not support initialization or committing or 
1530
1015
        some other features depending on the reason for not being supported.
1531
1016
        """
1532
1017
        return True
1533
1018
 
1534
 
    def make_tags(self, branch):
1535
 
        """Create a tags object for branch.
1536
 
 
1537
 
        This method is on BranchFormat, because BranchFormats are reflected
1538
 
        over the wire via network_name(), whereas full Branch instances require
1539
 
        multiple VFS method calls to operate at all.
1540
 
 
1541
 
        The default implementation returns a disabled-tags instance.
1542
 
 
1543
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1544
 
        on a RemoteBranch.
1545
 
        """
1546
 
        return DisabledTags(branch)
1547
 
 
1548
 
    def network_name(self):
1549
 
        """A simple byte string uniquely identifying this format for RPC calls.
1550
 
 
1551
 
        MetaDir branch formats use their disk format string to identify the
1552
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1553
 
        foreign formats like svn/git and hg should use some marker which is
1554
 
        unique and immutable.
1555
 
        """
1556
 
        raise NotImplementedError(self.network_name)
1557
 
 
1558
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1019
    def open(self, a_bzrdir, _found=False):
1559
1020
        """Return the branch object for a_bzrdir
1560
1021
 
1561
 
        :param a_bzrdir: A BzrDir that contains a branch.
1562
 
        :param _found: a private parameter, do not use it. It is used to
1563
 
            indicate if format probing has already be done.
1564
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1565
 
            (if there are any).  Default is to open fallbacks.
 
1022
        _found is a private parameter, do not use it. It is used to indicate
 
1023
               if format probing has already be done.
1566
1024
        """
1567
1025
        raise NotImplementedError(self.open)
1568
1026
 
1569
1027
    @classmethod
1570
1028
    def register_format(klass, format):
1571
 
        """Register a metadir format."""
1572
1029
        klass._formats[format.get_format_string()] = format
1573
 
        # Metadir formats have a network name of their format string, and get
1574
 
        # registered as class factories.
1575
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1576
1030
 
1577
1031
    @classmethod
1578
1032
    def set_default_format(klass, format):
1579
1033
        klass._default_format = format
1580
1034
 
1581
 
    def supports_set_append_revisions_only(self):
1582
 
        """True if this format supports set_append_revisions_only."""
1583
 
        return False
1584
 
 
1585
1035
    def supports_stacking(self):
1586
1036
        """True if this format records a stacked-on branch."""
1587
1037
        return False
1591
1041
        del klass._formats[format.get_format_string()]
1592
1042
 
1593
1043
    def __str__(self):
1594
 
        return self.get_format_description().rstrip()
 
1044
        return self.get_format_string().rstrip()
1595
1045
 
1596
1046
    def supports_tags(self):
1597
1047
        """True if this format supports tags stored in the branch"""
1600
1050
 
1601
1051
class BranchHooks(Hooks):
1602
1052
    """A dictionary mapping hook name to a list of callables for branch hooks.
1603
 
 
 
1053
    
1604
1054
    e.g. ['set_rh'] Is the list of items to be called when the
1605
1055
    set_revision_history function is invoked.
1606
1056
    """
1612
1062
        notified.
1613
1063
        """
1614
1064
        Hooks.__init__(self)
1615
 
        self.create_hook(HookPoint('set_rh',
1616
 
            "Invoked whenever the revision history has been set via "
1617
 
            "set_revision_history. The api signature is (branch, "
1618
 
            "revision_history), and the branch will be write-locked. "
1619
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1620
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1621
 
        self.create_hook(HookPoint('open',
1622
 
            "Called with the Branch object that has been opened after a "
1623
 
            "branch is opened.", (1, 8), None))
1624
 
        self.create_hook(HookPoint('post_push',
1625
 
            "Called after a push operation completes. post_push is called "
1626
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1627
 
            "bzr client.", (0, 15), None))
1628
 
        self.create_hook(HookPoint('post_pull',
1629
 
            "Called after a pull operation completes. post_pull is called "
1630
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1631
 
            "bzr client.", (0, 15), None))
1632
 
        self.create_hook(HookPoint('pre_commit',
1633
 
            "Called after a commit is calculated but before it is is "
1634
 
            "completed. pre_commit is called with (local, master, old_revno, "
1635
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1636
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1637
 
            "tree_delta is a TreeDelta object describing changes from the "
1638
 
            "basis revision. hooks MUST NOT modify this delta. "
1639
 
            " future_tree is an in-memory tree obtained from "
1640
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1641
 
            "tree.", (0,91), None))
1642
 
        self.create_hook(HookPoint('post_commit',
1643
 
            "Called in the bzr client after a commit has completed. "
1644
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1645
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1646
 
            "commit to a branch.", (0, 15), None))
1647
 
        self.create_hook(HookPoint('post_uncommit',
1648
 
            "Called in the bzr client after an uncommit completes. "
1649
 
            "post_uncommit is called with (local, master, old_revno, "
1650
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1651
 
            "or None, master is the target branch, and an empty branch "
1652
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1653
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1654
 
            "Called in bzr client and server before a change to the tip of a "
1655
 
            "branch is made. pre_change_branch_tip is called with a "
1656
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1657
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1658
 
        self.create_hook(HookPoint('post_change_branch_tip',
1659
 
            "Called in bzr client and server after a change to the tip of a "
1660
 
            "branch is made. post_change_branch_tip is called with a "
1661
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1662
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1663
 
        self.create_hook(HookPoint('transform_fallback_location',
1664
 
            "Called when a stacked branch is activating its fallback "
1665
 
            "locations. transform_fallback_location is called with (branch, "
1666
 
            "url), and should return a new url. Returning the same url "
1667
 
            "allows it to be used as-is, returning a different one can be "
1668
 
            "used to cause the branch to stack on a closer copy of that "
1669
 
            "fallback_location. Note that the branch cannot have history "
1670
 
            "accessing methods called on it during this hook because the "
1671
 
            "fallback locations have not been activated. When there are "
1672
 
            "multiple hooks installed for transform_fallback_location, "
1673
 
            "all are called with the url returned from the previous hook."
1674
 
            "The order is however undefined.", (1, 9), None))
 
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'] = []
1675
1124
 
1676
1125
 
1677
1126
# install the default hooks into the Branch class.
1709
1158
 
1710
1159
    def __eq__(self, other):
1711
1160
        return self.__dict__ == other.__dict__
1712
 
 
 
1161
    
1713
1162
    def __repr__(self):
1714
1163
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1715
 
            self.__class__.__name__, self.branch,
 
1164
            self.__class__.__name__, self.branch, 
1716
1165
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1717
1166
 
1718
1167
 
1740
1189
        super(BzrBranchFormat4, self).__init__()
1741
1190
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1742
1191
 
1743
 
    def network_name(self):
1744
 
        """The network name for this format is the control dirs disk label."""
1745
 
        return self._matchingbzrdir.get_format_string()
 
1192
    def open(self, a_bzrdir, _found=False):
 
1193
        """Return the branch object for a_bzrdir
1746
1194
 
1747
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1748
 
        """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
        """
1749
1198
        if not _found:
1750
1199
            # we are being called directly and must probe.
1751
1200
            raise NotImplementedError
1765
1214
        """What class to instantiate on open calls."""
1766
1215
        raise NotImplementedError(self._branch_class)
1767
1216
 
1768
 
    def network_name(self):
1769
 
        """A simple byte string uniquely identifying this format for RPC calls.
 
1217
    def open(self, a_bzrdir, _found=False):
 
1218
        """Return the branch object for a_bzrdir.
1770
1219
 
1771
 
        Metadir branch formats use their format string.
 
1220
        _found is a private parameter, do not use it. It is used to indicate
 
1221
               if format probing has already be done.
1772
1222
        """
1773
 
        return self.get_format_string()
1774
 
 
1775
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1776
 
        """See BranchFormat.open()."""
1777
1223
        if not _found:
1778
1224
            format = BranchFormat.find_format(a_bzrdir)
1779
1225
            if format.__class__ != self.__class__:
1786
1232
            return self._branch_class()(_format=self,
1787
1233
                              _control_files=control_files,
1788
1234
                              a_bzrdir=a_bzrdir,
1789
 
                              _repository=a_bzrdir.find_repository(),
1790
 
                              ignore_fallbacks=ignore_fallbacks)
 
1235
                              _repository=a_bzrdir.find_repository())
1791
1236
        except errors.NoSuchFile:
1792
1237
            raise errors.NotBranchError(path=transport.base)
1793
1238
 
1794
1239
    def __init__(self):
1795
1240
        super(BranchFormatMetadir, self).__init__()
1796
1241
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1797
 
        self._matchingbzrdir.set_branch_format(self)
1798
1242
 
1799
1243
    def supports_tags(self):
1800
1244
        return True
1823
1267
    def get_format_description(self):
1824
1268
        """See BranchFormat.get_format_description()."""
1825
1269
        return "Branch format 5"
1826
 
 
 
1270
        
1827
1271
    def initialize(self, a_bzrdir):
1828
1272
        """Create a branch of this format in a_bzrdir."""
1829
1273
        utf8_files = [('revision-history', ''),
1865
1309
                      ]
1866
1310
        return self._initialize_helper(a_bzrdir, utf8_files)
1867
1311
 
1868
 
    def make_tags(self, branch):
1869
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1870
 
        return BasicTags(branch)
1871
 
 
1872
 
    def supports_set_append_revisions_only(self):
1873
 
        return True
1874
 
 
1875
 
 
1876
 
class BzrBranchFormat8(BranchFormatMetadir):
1877
 
    """Metadir format supporting storing locations of subtree branches."""
1878
 
 
1879
 
    def _branch_class(self):
1880
 
        return BzrBranch8
1881
 
 
1882
 
    def get_format_string(self):
1883
 
        """See BranchFormat.get_format_string()."""
1884
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1885
 
 
1886
 
    def get_format_description(self):
1887
 
        """See BranchFormat.get_format_description()."""
1888
 
        return "Branch format 8"
1889
 
 
1890
 
    def initialize(self, a_bzrdir):
1891
 
        """Create a branch of this format in a_bzrdir."""
1892
 
        utf8_files = [('last-revision', '0 null:\n'),
1893
 
                      ('branch.conf', ''),
1894
 
                      ('tags', ''),
1895
 
                      ('references', '')
1896
 
                      ]
1897
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1898
 
 
1899
 
    def __init__(self):
1900
 
        super(BzrBranchFormat8, self).__init__()
1901
 
        self._matchingbzrdir.repository_format = \
1902
 
            RepositoryFormatKnitPack5RichRoot()
1903
 
 
1904
 
    def make_tags(self, branch):
1905
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1906
 
        return BasicTags(branch)
1907
 
 
1908
 
    def supports_set_append_revisions_only(self):
1909
 
        return True
1910
 
 
1911
 
    def supports_stacking(self):
1912
 
        return True
1913
 
 
1914
 
    supports_reference_locations = True
1915
 
 
1916
 
 
1917
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1312
 
 
1313
class BzrBranchFormat7(BranchFormatMetadir):
1918
1314
    """Branch format with last-revision, tags, and a stacked location pointer.
1919
1315
 
1920
1316
    The stacked location pointer is passed down to the repository and requires
1923
1319
    This format was introduced in bzr 1.6.
1924
1320
    """
1925
1321
 
1926
 
    def initialize(self, a_bzrdir):
1927
 
        """Create a branch of this format in a_bzrdir."""
1928
 
        utf8_files = [('last-revision', '0 null:\n'),
1929
 
                      ('branch.conf', ''),
1930
 
                      ('tags', ''),
1931
 
                      ]
1932
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1933
 
 
1934
1322
    def _branch_class(self):
1935
1323
        return BzrBranch7
1936
1324
 
1942
1330
        """See BranchFormat.get_format_description()."""
1943
1331
        return "Branch format 7"
1944
1332
 
1945
 
    def supports_set_append_revisions_only(self):
 
1333
    def initialize(self, a_bzrdir):
 
1334
        """Create a branch of this format in a_bzrdir."""
 
1335
        utf8_files = [('last-revision', '0 null:\n'),
 
1336
                      ('branch.conf', ''),
 
1337
                      ('tags', ''),
 
1338
                      ]
 
1339
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1340
 
 
1341
    def __init__(self):
 
1342
        super(BzrBranchFormat7, self).__init__()
 
1343
        self._matchingbzrdir.repository_format = \
 
1344
            RepositoryFormatPackDevelopment1Subtree()
 
1345
 
 
1346
    def supports_stacking(self):
1946
1347
        return True
1947
1348
 
1948
 
    supports_reference_locations = False
1949
 
 
1950
1349
 
1951
1350
class BranchReferenceFormat(BranchFormat):
1952
1351
    """Bzr branch reference format.
1995
1394
    def __init__(self):
1996
1395
        super(BranchReferenceFormat, self).__init__()
1997
1396
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1998
 
        self._matchingbzrdir.set_branch_format(self)
1999
1397
 
2000
1398
    def _make_reference_clone_function(format, a_branch):
2001
1399
        """Create a clone() routine for a branch dynamically."""
2002
 
        def clone(to_bzrdir, revision_id=None,
2003
 
            repository_policy=None):
 
1400
        def clone(to_bzrdir, revision_id=None):
2004
1401
            """See Branch.clone()."""
2005
1402
            return format.initialize(to_bzrdir, a_branch)
2006
1403
            # cannot obey revision_id limits when cloning a reference ...
2009
1406
        return clone
2010
1407
 
2011
1408
    def open(self, a_bzrdir, _found=False, location=None,
2012
 
             possible_transports=None, ignore_fallbacks=False):
 
1409
             possible_transports=None):
2013
1410
        """Return the branch that the branch reference in a_bzrdir points at.
2014
1411
 
2015
 
        :param a_bzrdir: A BzrDir that contains a branch.
2016
 
        :param _found: a private parameter, do not use it. It is used to
2017
 
            indicate if format probing has already be done.
2018
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2019
 
            (if there are any).  Default is to open fallbacks.
2020
 
        :param location: The location of the referenced branch.  If
2021
 
            unspecified, this will be determined from the branch reference in
2022
 
            a_bzrdir.
2023
 
        :param possible_transports: An optional reusable transports list.
 
1412
        _found is a private parameter, do not use it. It is used to indicate
 
1413
               if format probing has already be done.
2024
1414
        """
2025
1415
        if not _found:
2026
1416
            format = BranchFormat.find_format(a_bzrdir)
2031
1421
            location = self.get_reference(a_bzrdir)
2032
1422
        real_bzrdir = bzrdir.BzrDir.open(
2033
1423
            location, possible_transports=possible_transports)
2034
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
1424
        result = real_bzrdir.open_branch()
2035
1425
        # this changes the behaviour of result.clone to create a new reference
2036
1426
        # rather than a copy of the content of the branch.
2037
1427
        # I did not use a proxy object because that needs much more extensive
2044
1434
        return result
2045
1435
 
2046
1436
 
2047
 
network_format_registry = registry.FormatRegistry()
2048
 
"""Registry of formats indexed by their network name.
2049
 
 
2050
 
The network name for a branch format is an identifier that can be used when
2051
 
referring to formats with smart server operations. See
2052
 
BranchFormat.network_name() for more detail.
2053
 
"""
2054
 
 
2055
 
 
2056
1437
# formats which have no format string are not discoverable
2057
1438
# and not independently creatable, so are not registered.
2058
1439
__format5 = BzrBranchFormat5()
2059
1440
__format6 = BzrBranchFormat6()
2060
1441
__format7 = BzrBranchFormat7()
2061
 
__format8 = BzrBranchFormat8()
2062
1442
BranchFormat.register_format(__format5)
2063
1443
BranchFormat.register_format(BranchReferenceFormat())
2064
1444
BranchFormat.register_format(__format6)
2065
1445
BranchFormat.register_format(__format7)
2066
 
BranchFormat.register_format(__format8)
2067
1446
BranchFormat.set_default_format(__format6)
2068
1447
_legacy_formats = [BzrBranchFormat4(),
2069
 
    ]
2070
 
network_format_registry.register(
2071
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2072
 
 
 
1448
                   ]
2073
1449
 
2074
1450
class BzrBranch(Branch):
2075
1451
    """A branch stored in the actual filesystem.
2078
1454
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
2079
1455
    it's writable, and can be accessed via the normal filesystem API.
2080
1456
 
2081
 
    :ivar _transport: Transport for file operations on this branch's
 
1457
    :ivar _transport: Transport for file operations on this branch's 
2082
1458
        control files, typically pointing to the .bzr/branch directory.
2083
1459
    :ivar repository: Repository for this branch.
2084
 
    :ivar base: The url of the base directory for this branch; the one
 
1460
    :ivar base: The url of the base directory for this branch; the one 
2085
1461
        containing the .bzr directory.
2086
1462
    """
2087
 
 
 
1463
    
2088
1464
    def __init__(self, _format=None,
2089
 
                 _control_files=None, a_bzrdir=None, _repository=None,
2090
 
                 ignore_fallbacks=False):
 
1465
                 _control_files=None, a_bzrdir=None, _repository=None):
2091
1466
        """Create new branch object at a particular location."""
2092
1467
        if a_bzrdir is None:
2093
1468
            raise ValueError('a_bzrdir must be supplied')
2116
1491
 
2117
1492
    base = property(_get_base, doc="The URL for the root of this branch.")
2118
1493
 
2119
 
    def _get_config(self):
2120
 
        return TransportConfig(self._transport, 'branch.conf')
2121
 
 
2122
1494
    def is_locked(self):
2123
1495
        return self.control_files.is_locked()
2124
1496
 
2125
1497
    def lock_write(self, token=None):
2126
 
        # All-in-one needs to always unlock/lock.
2127
 
        repo_control = getattr(self.repository, 'control_files', None)
2128
 
        if self.control_files == repo_control or not self.is_locked():
2129
 
            self.repository.lock_write()
2130
 
            took_lock = True
2131
 
        else:
2132
 
            took_lock = False
 
1498
        repo_token = self.repository.lock_write()
2133
1499
        try:
2134
 
            return self.control_files.lock_write(token=token)
 
1500
            token = self.control_files.lock_write(token=token)
2135
1501
        except:
2136
 
            if took_lock:
2137
 
                self.repository.unlock()
 
1502
            self.repository.unlock()
2138
1503
            raise
 
1504
        return token
2139
1505
 
2140
1506
    def lock_read(self):
2141
 
        # All-in-one needs to always unlock/lock.
2142
 
        repo_control = getattr(self.repository, 'control_files', None)
2143
 
        if self.control_files == repo_control or not self.is_locked():
2144
 
            self.repository.lock_read()
2145
 
            took_lock = True
2146
 
        else:
2147
 
            took_lock = False
 
1507
        self.repository.lock_read()
2148
1508
        try:
2149
1509
            self.control_files.lock_read()
2150
1510
        except:
2151
 
            if took_lock:
2152
 
                self.repository.unlock()
 
1511
            self.repository.unlock()
2153
1512
            raise
2154
1513
 
2155
1514
    def unlock(self):
 
1515
        # TODO: test for failed two phase locks. This is known broken.
2156
1516
        try:
2157
1517
            self.control_files.unlock()
2158
1518
        finally:
2159
 
            # All-in-one needs to always unlock/lock.
2160
 
            repo_control = getattr(self.repository, 'control_files', None)
2161
 
            if (self.control_files == repo_control or
2162
 
                not self.control_files.is_locked()):
2163
 
                self.repository.unlock()
2164
 
            if not self.control_files.is_locked():
2165
 
                # we just released the lock
2166
 
                self._clear_cached_state()
2167
 
 
 
1519
            self.repository.unlock()
 
1520
        if not self.control_files.is_locked():
 
1521
            # we just released the lock
 
1522
            self._clear_cached_state()
 
1523
        
2168
1524
    def peek_lock_mode(self):
2169
1525
        if self.control_files._lock_count == 0:
2170
1526
            return None
2213
1569
        if Branch.hooks['post_change_branch_tip']:
2214
1570
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2215
1571
 
2216
 
    def _synchronize_history(self, destination, revision_id):
2217
 
        """Synchronize last revision and revision history between branches.
2218
 
 
2219
 
        This version is most efficient when the destination is also a
2220
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2221
 
        history is the true lefthand parent history, and all of the revisions
2222
 
        are in the destination's repository.  If not, set_revision_history
2223
 
        will fail.
2224
 
 
2225
 
        :param destination: The branch to copy the history into
2226
 
        :param revision_id: The revision-id to truncate history at.  May
2227
 
          be None to copy complete history.
2228
 
        """
2229
 
        if not isinstance(destination._format, BzrBranchFormat5):
2230
 
            super(BzrBranch, self)._synchronize_history(
2231
 
                destination, revision_id)
 
1572
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1573
        """Run the pre_change_branch_tip hooks."""
 
1574
        hooks = Branch.hooks['pre_change_branch_tip']
 
1575
        if not hooks:
2232
1576
            return
2233
 
        if revision_id == _mod_revision.NULL_REVISION:
2234
 
            new_history = []
2235
 
        else:
2236
 
            new_history = self.revision_history()
2237
 
        if revision_id is not None and new_history != []:
 
1577
        old_revno, old_revid = self.last_revision_info()
 
1578
        params = ChangeBranchTipParams(
 
1579
            self, old_revno, new_revno, old_revid, new_revid)
 
1580
        for hook in hooks:
2238
1581
            try:
2239
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2240
 
            except ValueError:
2241
 
                rev = self.repository.get_revision(revision_id)
2242
 
                new_history = rev.get_history(self.repository)[1:]
2243
 
        destination.set_revision_history(new_history)
2244
 
 
 
1582
                hook(params)
 
1583
            except errors.TipChangeRejected:
 
1584
                raise
 
1585
            except Exception:
 
1586
                exc_info = sys.exc_info()
 
1587
                hook_name = Branch.hooks.get_hook_name(hook)
 
1588
                raise errors.HookFailed(
 
1589
                    'pre_change_branch_tip', hook_name, exc_info)
 
1590
 
 
1591
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1592
        """Run the post_change_branch_tip hooks."""
 
1593
        hooks = Branch.hooks['post_change_branch_tip']
 
1594
        if not hooks:
 
1595
            return
 
1596
        new_revno, new_revid = self.last_revision_info()
 
1597
        params = ChangeBranchTipParams(
 
1598
            self, old_revno, new_revno, old_revid, new_revid)
 
1599
        for hook in hooks:
 
1600
            hook(params)
 
1601
 
2245
1602
    @needs_write_lock
2246
1603
    def set_last_revision_info(self, revno, revision_id):
2247
1604
        """Set the last revision of this branch.
2250
1607
        for this revision id.
2251
1608
 
2252
1609
        It may be possible to set the branch last revision to an id not
2253
 
        present in the repository.  However, branches can also be
 
1610
        present in the repository.  However, branches can also be 
2254
1611
        configured to check constraints on history, in which case this may not
2255
1612
        be permitted.
2256
1613
        """
2270
1627
            history.pop()
2271
1628
        return history
2272
1629
 
 
1630
    def _lefthand_history(self, revision_id, last_rev=None,
 
1631
                          other_branch=None):
 
1632
        if 'evil' in debug.debug_flags:
 
1633
            mutter_callsite(4, "_lefthand_history scales with history.")
 
1634
        # stop_revision must be a descendant of last_revision
 
1635
        graph = self.repository.get_graph()
 
1636
        if last_rev is not None:
 
1637
            if not graph.is_ancestor(last_rev, revision_id):
 
1638
                # our previous tip is not merged into stop_revision
 
1639
                raise errors.DivergedBranches(self, other_branch)
 
1640
        # make a new revision history from the graph
 
1641
        parents_map = graph.get_parent_map([revision_id])
 
1642
        if revision_id not in parents_map:
 
1643
            raise errors.NoSuchRevision(self, revision_id)
 
1644
        current_rev_id = revision_id
 
1645
        new_history = []
 
1646
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
1647
        # Do not include ghosts or graph origin in revision_history
 
1648
        while (current_rev_id in parents_map and
 
1649
               len(parents_map[current_rev_id]) > 0):
 
1650
            check_not_reserved_id(current_rev_id)
 
1651
            new_history.append(current_rev_id)
 
1652
            current_rev_id = parents_map[current_rev_id][0]
 
1653
            parents_map = graph.get_parent_map([current_rev_id])
 
1654
        new_history.reverse()
 
1655
        return new_history
 
1656
 
2273
1657
    @needs_write_lock
2274
1658
    def generate_revision_history(self, revision_id, last_rev=None,
2275
1659
        other_branch=None):
2288
1672
        """See Branch.basis_tree."""
2289
1673
        return self.repository.revision_tree(self.last_revision())
2290
1674
 
 
1675
    @needs_write_lock
 
1676
    def pull(self, source, overwrite=False, stop_revision=None,
 
1677
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1678
             _override_hook_target=None):
 
1679
        """See Branch.pull.
 
1680
 
 
1681
        :param _hook_master: Private parameter - set the branch to 
 
1682
            be supplied as the master to pull hooks.
 
1683
        :param run_hooks: Private parameter - if false, this branch
 
1684
            is being called because it's the master of the primary branch,
 
1685
            so it should not run its hooks.
 
1686
        :param _override_hook_target: Private parameter - set the branch to be
 
1687
            supplied as the target_branch to pull hooks.
 
1688
        """
 
1689
        result = PullResult()
 
1690
        result.source_branch = source
 
1691
        if _override_hook_target is None:
 
1692
            result.target_branch = self
 
1693
        else:
 
1694
            result.target_branch = _override_hook_target
 
1695
        source.lock_read()
 
1696
        try:
 
1697
            # We assume that during 'pull' the local repository is closer than
 
1698
            # the remote one.
 
1699
            graph = self.repository.get_graph(source.repository)
 
1700
            result.old_revno, result.old_revid = self.last_revision_info()
 
1701
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1702
                                  graph=graph)
 
1703
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1704
            result.new_revno, result.new_revid = self.last_revision_info()
 
1705
            if _hook_master:
 
1706
                result.master_branch = _hook_master
 
1707
                result.local_branch = result.target_branch
 
1708
            else:
 
1709
                result.master_branch = result.target_branch
 
1710
                result.local_branch = None
 
1711
            if run_hooks:
 
1712
                for hook in Branch.hooks['post_pull']:
 
1713
                    hook(result)
 
1714
        finally:
 
1715
            source.unlock()
 
1716
        return result
 
1717
 
2291
1718
    def _get_parent_location(self):
2292
1719
        _locs = ['parent', 'pull', 'x-pull']
2293
1720
        for l in _locs:
2297
1724
                pass
2298
1725
        return None
2299
1726
 
 
1727
    @needs_read_lock
 
1728
    def push(self, target, overwrite=False, stop_revision=None,
 
1729
             _override_hook_source_branch=None):
 
1730
        """See Branch.push.
 
1731
 
 
1732
        This is the basic concrete implementation of push()
 
1733
 
 
1734
        :param _override_hook_source_branch: If specified, run
 
1735
        the hooks passing this Branch as the source, rather than self.  
 
1736
        This is for use of RemoteBranch, where push is delegated to the
 
1737
        underlying vfs-based Branch. 
 
1738
        """
 
1739
        # TODO: Public option to disable running hooks - should be trivial but
 
1740
        # needs tests.
 
1741
        target.lock_write()
 
1742
        try:
 
1743
            result = self._push_with_bound_branches(target, overwrite,
 
1744
                    stop_revision,
 
1745
                    _override_hook_source_branch=_override_hook_source_branch)
 
1746
            return result
 
1747
        finally:
 
1748
            target.unlock()
 
1749
 
 
1750
    def _push_with_bound_branches(self, target, overwrite,
 
1751
            stop_revision,
 
1752
            _override_hook_source_branch=None):
 
1753
        """Push from self into target, and into target's master if any.
 
1754
        
 
1755
        This is on the base BzrBranch class even though it doesn't support 
 
1756
        bound branches because the *target* might be bound.
 
1757
        """
 
1758
        def _run_hooks():
 
1759
            if _override_hook_source_branch:
 
1760
                result.source_branch = _override_hook_source_branch
 
1761
            for hook in Branch.hooks['post_push']:
 
1762
                hook(result)
 
1763
 
 
1764
        bound_location = target.get_bound_location()
 
1765
        if bound_location and target.base != bound_location:
 
1766
            # there is a master branch.
 
1767
            #
 
1768
            # XXX: Why the second check?  Is it even supported for a branch to
 
1769
            # be bound to itself? -- mbp 20070507
 
1770
            master_branch = target.get_master_branch()
 
1771
            master_branch.lock_write()
 
1772
            try:
 
1773
                # push into the master from this branch.
 
1774
                self._basic_push(master_branch, overwrite, stop_revision)
 
1775
                # and push into the target branch from this. Note that we push from
 
1776
                # this branch again, because its considered the highest bandwidth
 
1777
                # repository.
 
1778
                result = self._basic_push(target, overwrite, stop_revision)
 
1779
                result.master_branch = master_branch
 
1780
                result.local_branch = target
 
1781
                _run_hooks()
 
1782
                return result
 
1783
            finally:
 
1784
                master_branch.unlock()
 
1785
        else:
 
1786
            # no master branch
 
1787
            result = self._basic_push(target, overwrite, stop_revision)
 
1788
            # TODO: Why set master_branch and local_branch if there's no
 
1789
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
1790
            # 20070504
 
1791
            result.master_branch = target
 
1792
            result.local_branch = None
 
1793
            _run_hooks()
 
1794
            return result
 
1795
 
2300
1796
    def _basic_push(self, target, overwrite, stop_revision):
2301
1797
        """Basic implementation of push without bound branches or hooks.
2302
1798
 
2303
 
        Must be called with source read locked and target write locked.
 
1799
        Must be called with self read locked and target write locked.
2304
1800
        """
2305
 
        result = BranchPushResult()
 
1801
        result = PushResult()
2306
1802
        result.source_branch = self
2307
1803
        result.target_branch = target
2308
1804
        result.old_revno, result.old_revid = target.last_revision_info()
2309
 
        self.update_references(target)
2310
 
        if result.old_revid != self.last_revision():
2311
 
            # We assume that during 'push' this repository is closer than
2312
 
            # the target.
2313
 
            graph = self.repository.get_graph(target.repository)
2314
 
            target.update_revisions(self, stop_revision,
2315
 
                overwrite=overwrite, graph=graph)
2316
 
        if self._push_should_merge_tags():
2317
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2318
 
                overwrite)
 
1805
 
 
1806
        # We assume that during 'push' this repository is closer than
 
1807
        # the target.
 
1808
        graph = self.repository.get_graph(target.repository)
 
1809
        target.update_revisions(self, stop_revision, overwrite=overwrite,
 
1810
                                graph=graph)
 
1811
        result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2319
1812
        result.new_revno, result.new_revid = target.last_revision_info()
2320
1813
        return result
2321
1814
 
 
1815
    def get_parent(self):
 
1816
        """See Branch.get_parent."""
 
1817
        parent = self._get_parent_location()
 
1818
        if parent is None:
 
1819
            return parent
 
1820
        # This is an old-format absolute path to a local branch
 
1821
        # turn it into a url
 
1822
        if parent.startswith('/'):
 
1823
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1824
        try:
 
1825
            return urlutils.join(self.base[:-1], parent)
 
1826
        except errors.InvalidURLJoin, e:
 
1827
            raise errors.InaccessibleParent(parent, self.base)
 
1828
 
2322
1829
    def get_stacked_on_url(self):
2323
1830
        raise errors.UnstackableBranchFormat(self._format, self.base)
2324
1831
 
2328
1835
            'push_location', location,
2329
1836
            store=_mod_config.STORE_LOCATION_NORECURSE)
2330
1837
 
 
1838
    @needs_write_lock
 
1839
    def set_parent(self, url):
 
1840
        """See Branch.set_parent."""
 
1841
        # TODO: Maybe delete old location files?
 
1842
        # URLs should never be unicode, even on the local fs,
 
1843
        # FIXUP this and get_parent in a future branch format bump:
 
1844
        # read and rewrite the file. RBC 20060125
 
1845
        if url is not None:
 
1846
            if isinstance(url, unicode):
 
1847
                try:
 
1848
                    url = url.encode('ascii')
 
1849
                except UnicodeEncodeError:
 
1850
                    raise errors.InvalidURL(url,
 
1851
                        "Urls must be 7-bit ascii, "
 
1852
                        "use bzrlib.urlutils.escape")
 
1853
            url = urlutils.relative_url(self.base, url)
 
1854
        self._set_parent_location(url)
 
1855
 
2331
1856
    def _set_parent_location(self, url):
2332
1857
        if url is None:
2333
1858
            self._transport.delete('parent')
2335
1860
            self._transport.put_bytes('parent', url + '\n',
2336
1861
                mode=self.bzrdir._get_file_mode())
2337
1862
 
 
1863
    def set_stacked_on_url(self, url):
 
1864
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1865
 
2338
1866
 
2339
1867
class BzrBranch5(BzrBranch):
2340
1868
    """A format 5 branch. This supports new features over plain branches.
2342
1870
    It has support for a master_branch which is the data for bound branches.
2343
1871
    """
2344
1872
 
 
1873
    @needs_write_lock
 
1874
    def pull(self, source, overwrite=False, stop_revision=None,
 
1875
             run_hooks=True, possible_transports=None,
 
1876
             _override_hook_target=None):
 
1877
        """Pull from source into self, updating my master if any.
 
1878
        
 
1879
        :param run_hooks: Private parameter - if false, this branch
 
1880
            is being called because it's the master of the primary branch,
 
1881
            so it should not run its hooks.
 
1882
        """
 
1883
        bound_location = self.get_bound_location()
 
1884
        master_branch = None
 
1885
        if bound_location and source.base != bound_location:
 
1886
            # not pulling from master, so we need to update master.
 
1887
            master_branch = self.get_master_branch(possible_transports)
 
1888
            master_branch.lock_write()
 
1889
        try:
 
1890
            if master_branch:
 
1891
                # pull from source into master.
 
1892
                master_branch.pull(source, overwrite, stop_revision,
 
1893
                    run_hooks=False)
 
1894
            return super(BzrBranch5, self).pull(source, overwrite,
 
1895
                stop_revision, _hook_master=master_branch,
 
1896
                run_hooks=run_hooks,
 
1897
                _override_hook_target=_override_hook_target)
 
1898
        finally:
 
1899
            if master_branch:
 
1900
                master_branch.unlock()
 
1901
 
2345
1902
    def get_bound_location(self):
2346
1903
        try:
2347
1904
            return self._transport.get_bytes('bound')[:-1]
2351
1908
    @needs_read_lock
2352
1909
    def get_master_branch(self, possible_transports=None):
2353
1910
        """Return the branch we are bound to.
2354
 
 
 
1911
        
2355
1912
        :return: Either a Branch, or None
2356
1913
 
2357
1914
        This could memoise the branch, but if thats done
2393
1950
        check for divergence to raise an error when the branches are not
2394
1951
        either the same, or one a prefix of the other. That behaviour may not
2395
1952
        be useful, so that check may be removed in future.
2396
 
 
 
1953
        
2397
1954
        :param other: The branch to bind to
2398
1955
        :type other: Branch
2399
1956
        """
2418
1975
 
2419
1976
    @needs_write_lock
2420
1977
    def update(self, possible_transports=None):
2421
 
        """Synchronise this branch with the master branch if any.
 
1978
        """Synchronise this branch with the master branch if any. 
2422
1979
 
2423
1980
        :return: None or the last_revision that was pivoted out during the
2424
1981
                 update.
2434
1991
        return None
2435
1992
 
2436
1993
 
2437
 
class BzrBranch8(BzrBranch5):
2438
 
    """A branch that stores tree-reference locations."""
 
1994
class BzrBranch7(BzrBranch5):
 
1995
    """A branch with support for a fallback repository."""
 
1996
 
 
1997
    def _get_fallback_repository(self, url):
 
1998
        """Get the repository we fallback to at url."""
 
1999
        url = urlutils.join(self.base, url)
 
2000
        return bzrdir.BzrDir.open(url).open_branch().repository
 
2001
 
 
2002
    def _activate_fallback_location(self, url):
 
2003
        """Activate the branch/repository from url as a fallback repository."""
 
2004
        self.repository.add_fallback_repository(
 
2005
            self._get_fallback_repository(url))
2439
2006
 
2440
2007
    def _open_hook(self):
2441
 
        if self._ignore_fallbacks:
2442
 
            return
2443
2008
        try:
2444
2009
            url = self.get_stacked_on_url()
2445
2010
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2446
2011
            errors.UnstackableBranchFormat):
2447
2012
            pass
2448
2013
        else:
2449
 
            for hook in Branch.hooks['transform_fallback_location']:
2450
 
                url = hook(self, url)
2451
 
                if url is None:
2452
 
                    hook_name = Branch.hooks.get_hook_name(hook)
2453
 
                    raise AssertionError(
2454
 
                        "'transform_fallback_location' hook %s returned "
2455
 
                        "None, not a URL." % hook_name)
2456
2014
            self._activate_fallback_location(url)
2457
2015
 
 
2016
    def _check_stackable_repo(self):
 
2017
        if not self.repository._format.supports_external_lookups:
 
2018
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2019
                self.repository.base)
 
2020
 
2458
2021
    def __init__(self, *args, **kwargs):
2459
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2460
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2022
        super(BzrBranch7, self).__init__(*args, **kwargs)
2461
2023
        self._last_revision_info_cache = None
2462
 
        self._reference_info = None
 
2024
        self._partial_revision_history_cache = []
2463
2025
 
2464
2026
    def _clear_cached_state(self):
2465
 
        super(BzrBranch8, self)._clear_cached_state()
 
2027
        super(BzrBranch7, self)._clear_cached_state()
2466
2028
        self._last_revision_info_cache = None
2467
 
        self._reference_info = None
 
2029
        self._partial_revision_history_cache = []
2468
2030
 
2469
2031
    def _last_revision_info(self):
2470
2032
        revision_string = self._transport.get_bytes('last-revision')
2499
2061
        self._last_revision_info_cache = revno, revision_id
2500
2062
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2501
2063
 
2502
 
    def _synchronize_history(self, destination, revision_id):
2503
 
        """Synchronize last revision and revision history between branches.
2504
 
 
2505
 
        :see: Branch._synchronize_history
2506
 
        """
2507
 
        # XXX: The base Branch has a fast implementation of this method based
2508
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2509
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2510
 
        # but wants the fast implementation, so it calls
2511
 
        # Branch._synchronize_history directly.
2512
 
        Branch._synchronize_history(self, destination, revision_id)
2513
 
 
2514
2064
    def _check_history_violation(self, revision_id):
2515
2065
        last_revision = _mod_revision.ensure_null(self.last_revision())
2516
2066
        if _mod_revision.is_null(last_revision):
2525
2075
        self._extend_partial_history(stop_index=last_revno-1)
2526
2076
        return list(reversed(self._partial_revision_history_cache))
2527
2077
 
 
2078
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2079
        """Extend the partial history to include a given index
 
2080
 
 
2081
        If a stop_index is supplied, stop when that index has been reached.
 
2082
        If a stop_revision is supplied, stop when that revision is
 
2083
        encountered.  Otherwise, stop when the beginning of history is
 
2084
        reached.
 
2085
 
 
2086
        :param stop_index: The index which should be present.  When it is
 
2087
            present, history extension will stop.
 
2088
        :param revision_id: The revision id which should be present.  When
 
2089
            it is encountered, history extension will stop.
 
2090
        """
 
2091
        repo = self.repository
 
2092
        if len(self._partial_revision_history_cache) == 0:
 
2093
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2094
        else:
 
2095
            start_revision = self._partial_revision_history_cache[-1]
 
2096
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2097
            #skip the last revision in the list
 
2098
            next_revision = iterator.next()
 
2099
        for revision_id in iterator:
 
2100
            self._partial_revision_history_cache.append(revision_id)
 
2101
            if (stop_index is not None and
 
2102
                len(self._partial_revision_history_cache) > stop_index):
 
2103
                break
 
2104
            if revision_id == stop_revision:
 
2105
                break
 
2106
 
2528
2107
    def _write_revision_history(self, history):
2529
2108
        """Factored out of set_revision_history.
2530
2109
 
2551
2130
        """Set the parent branch"""
2552
2131
        return self._get_config_location('parent_location')
2553
2132
 
2554
 
    @needs_write_lock
2555
 
    def _set_all_reference_info(self, info_dict):
2556
 
        """Replace all reference info stored in a branch.
2557
 
 
2558
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2559
 
        """
2560
 
        s = StringIO()
2561
 
        writer = rio.RioWriter(s)
2562
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2563
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2564
 
                                branch_location=branch_location)
2565
 
            writer.write_stanza(stanza)
2566
 
        self._transport.put_bytes('references', s.getvalue())
2567
 
        self._reference_info = info_dict
2568
 
 
2569
 
    @needs_read_lock
2570
 
    def _get_all_reference_info(self):
2571
 
        """Return all the reference info stored in a branch.
2572
 
 
2573
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2574
 
        """
2575
 
        if self._reference_info is not None:
2576
 
            return self._reference_info
2577
 
        rio_file = self._transport.get('references')
2578
 
        try:
2579
 
            stanzas = rio.read_stanzas(rio_file)
2580
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2581
 
                             s['branch_location'])) for s in stanzas)
2582
 
        finally:
2583
 
            rio_file.close()
2584
 
        self._reference_info = info_dict
2585
 
        return info_dict
2586
 
 
2587
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2588
 
        """Set the branch location to use for a tree reference.
2589
 
 
2590
 
        :param file_id: The file-id of the tree reference.
2591
 
        :param tree_path: The path of the tree reference in the tree.
2592
 
        :param branch_location: The location of the branch to retrieve tree
2593
 
            references from.
2594
 
        """
2595
 
        info_dict = self._get_all_reference_info()
2596
 
        info_dict[file_id] = (tree_path, branch_location)
2597
 
        if None in (tree_path, branch_location):
2598
 
            if tree_path is not None:
2599
 
                raise ValueError('tree_path must be None when branch_location'
2600
 
                                 ' is None.')
2601
 
            if branch_location is not None:
2602
 
                raise ValueError('branch_location must be None when tree_path'
2603
 
                                 ' is None.')
2604
 
            del info_dict[file_id]
2605
 
        self._set_all_reference_info(info_dict)
2606
 
 
2607
 
    def get_reference_info(self, file_id):
2608
 
        """Get the tree_path and branch_location for a tree reference.
2609
 
 
2610
 
        :return: a tuple of (tree_path, branch_location)
2611
 
        """
2612
 
        return self._get_all_reference_info().get(file_id, (None, None))
2613
 
 
2614
 
    def reference_parent(self, file_id, path, possible_transports=None):
2615
 
        """Return the parent branch for a tree-reference file_id.
2616
 
 
2617
 
        :param file_id: The file_id of the tree reference
2618
 
        :param path: The path of the file_id in the tree
2619
 
        :return: A branch associated with the file_id
2620
 
        """
2621
 
        branch_location = self.get_reference_info(file_id)[1]
2622
 
        if branch_location is None:
2623
 
            return Branch.reference_parent(self, file_id, path,
2624
 
                                           possible_transports)
2625
 
        branch_location = urlutils.join(self.base, branch_location)
2626
 
        return Branch.open(branch_location,
2627
 
                           possible_transports=possible_transports)
2628
 
 
2629
2133
    def set_push_location(self, location):
2630
2134
        """See Branch.set_push_location."""
2631
2135
        self._set_config_location('push_location', location)
2665
2169
        return self._get_bound_location(False)
2666
2170
 
2667
2171
    def get_stacked_on_url(self):
2668
 
        # you can always ask for the URL; but you might not be able to use it
2669
 
        # if the repo can't support stacking.
2670
 
        ## self._check_stackable_repo()
 
2172
        self._check_stackable_repo()
2671
2173
        stacked_url = self._get_config_location('stacked_on_location')
2672
2174
        if stacked_url is None:
2673
2175
            raise errors.NotStacked(self)
2674
2176
        return stacked_url
2675
2177
 
 
2178
    def set_append_revisions_only(self, enabled):
 
2179
        if enabled:
 
2180
            value = 'True'
 
2181
        else:
 
2182
            value = 'False'
 
2183
        self.get_config().set_user_option('append_revisions_only', value,
 
2184
            warn_masked=True)
 
2185
 
 
2186
    def set_stacked_on_url(self, url):
 
2187
        self._check_stackable_repo()
 
2188
        if not url:
 
2189
            try:
 
2190
                old_url = self.get_stacked_on_url()
 
2191
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2192
                errors.UnstackableRepositoryFormat):
 
2193
                return
 
2194
            url = ''
 
2195
            # repositories don't offer an interface to remove fallback
 
2196
            # repositories today; take the conceptually simpler option and just
 
2197
            # reopen it.
 
2198
            self.repository = self.bzrdir.find_repository()
 
2199
            # for every revision reference the branch has, ensure it is pulled
 
2200
            # in.
 
2201
            source_repository = self._get_fallback_repository(old_url)
 
2202
            for revision_id in chain([self.last_revision()],
 
2203
                self.tags.get_reverse_tag_dict()):
 
2204
                self.repository.fetch(source_repository, revision_id,
 
2205
                    find_ghosts=True)
 
2206
        else:
 
2207
            self._activate_fallback_location(url)
 
2208
        # write this out after the repository is stacked to avoid setting a
 
2209
        # stacked config that doesn't work.
 
2210
        self._set_config_location('stacked_on_location', url)
 
2211
 
2676
2212
    def _get_append_revisions_only(self):
2677
2213
        value = self.get_config().get_user_option('append_revisions_only')
2678
2214
        return value == 'True'
2679
2215
 
 
2216
    def _synchronize_history(self, destination, revision_id):
 
2217
        """Synchronize last revision and revision history between branches.
 
2218
 
 
2219
        This version is most efficient when the destination is also a
 
2220
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
2221
        repository contains all the lefthand ancestors of the intended
 
2222
        last_revision.  If not, set_last_revision_info will fail.
 
2223
 
 
2224
        :param destination: The branch to copy the history into
 
2225
        :param revision_id: The revision-id to truncate history at.  May
 
2226
          be None to copy complete history.
 
2227
        """
 
2228
        source_revno, source_revision_id = self.last_revision_info()
 
2229
        if revision_id is None:
 
2230
            revno, revision_id = source_revno, source_revision_id
 
2231
        elif source_revision_id == revision_id:
 
2232
            # we know the revno without needing to walk all of history
 
2233
            revno = source_revno
 
2234
        else:
 
2235
            # To figure out the revno for a random revision, we need to build
 
2236
            # the revision history, and count its length.
 
2237
            # We don't care about the order, just how long it is.
 
2238
            # Alternatively, we could start at the current location, and count
 
2239
            # backwards. But there is no guarantee that we will find it since
 
2240
            # it may be a merged revision.
 
2241
            revno = len(list(self.repository.iter_reverse_revision_history(
 
2242
                                                                revision_id)))
 
2243
        destination.set_last_revision_info(revno, revision_id)
 
2244
 
 
2245
    def _make_tags(self):
 
2246
        return BasicTags(self)
 
2247
 
2680
2248
    @needs_write_lock
2681
2249
    def generate_revision_history(self, revision_id, last_rev=None,
2682
2250
                                  other_branch=None):
2721
2289
        return self.revno() - index
2722
2290
 
2723
2291
 
2724
 
class BzrBranch7(BzrBranch8):
2725
 
    """A branch with support for a fallback repository."""
2726
 
 
2727
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2728
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2729
 
 
2730
 
    def get_reference_info(self, file_id):
2731
 
        Branch.get_reference_info(self, file_id)
2732
 
 
2733
 
    def reference_parent(self, file_id, path, possible_transports=None):
2734
 
        return Branch.reference_parent(self, file_id, path,
2735
 
                                       possible_transports)
2736
 
 
2737
 
 
2738
2292
class BzrBranch6(BzrBranch7):
2739
2293
    """See BzrBranchFormat6 for the capabilities of this branch.
2740
2294
 
2745
2299
    def get_stacked_on_url(self):
2746
2300
        raise errors.UnstackableBranchFormat(self._format, self.base)
2747
2301
 
 
2302
    def set_stacked_on_url(self, url):
 
2303
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2304
 
2748
2305
 
2749
2306
######################################################################
2750
2307
# results of operations
2767
2324
    :ivar new_revno: Revision number after pull.
2768
2325
    :ivar old_revid: Tip revision id before pull.
2769
2326
    :ivar new_revid: Tip revision id after pull.
2770
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2327
    :ivar source_branch: Source (local) branch object.
2771
2328
    :ivar master_branch: Master branch of the target, or the target if no
2772
2329
        Master
2773
2330
    :ivar local_branch: target branch if there is a Master, else None
2774
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2331
    :ivar target_branch: Target/destination branch object.
2775
2332
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2776
2333
    """
2777
2334
 
2788
2345
        self._show_tag_conficts(to_file)
2789
2346
 
2790
2347
 
2791
 
class BranchPushResult(_Result):
 
2348
class PushResult(_Result):
2792
2349
    """Result of a Branch.push operation.
2793
2350
 
2794
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
2795
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
2796
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2797
 
        before the push.
2798
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2799
 
        after the push.
2800
 
    :ivar source_branch: Source branch object that the push was from. This is
2801
 
        read locked, and generally is a local (and thus low latency) branch.
2802
 
    :ivar master_branch: If target is a bound branch, the master branch of
2803
 
        target, or target itself. Always write locked.
2804
 
    :ivar target_branch: The direct Branch where data is being sent (write
2805
 
        locked).
2806
 
    :ivar local_branch: If the target is a bound branch this will be the
2807
 
        target, otherwise it will be None.
 
2351
    :ivar old_revno: Revision number before push.
 
2352
    :ivar new_revno: Revision number after push.
 
2353
    :ivar old_revid: Tip revision id before push.
 
2354
    :ivar new_revid: Tip revision id after push.
 
2355
    :ivar source_branch: Source branch object.
 
2356
    :ivar master_branch: Master branch of the target, or None.
 
2357
    :ivar target_branch: Target/destination branch object.
2808
2358
    """
2809
2359
 
2810
2360
    def __int__(self):
2814
2364
    def report(self, to_file):
2815
2365
        """Write a human-readable description of the result."""
2816
2366
        if self.old_revid == self.new_revid:
2817
 
            note('No new revisions to push.')
 
2367
            to_file.write('No new revisions to push.\n')
2818
2368
        else:
2819
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2369
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2820
2370
        self._show_tag_conficts(to_file)
2821
2371
 
2822
2372
 
2828
2378
 
2829
2379
    def __init__(self, branch):
2830
2380
        self.branch = branch
2831
 
        self.errors = []
2832
2381
 
2833
2382
    def report_results(self, verbose):
2834
2383
        """Report the check results via trace.note.
2835
 
 
 
2384
        
2836
2385
        :param verbose: Requests more detailed display of what was checked,
2837
2386
            if any.
2838
2387
        """
2839
 
        note('checked branch %s format %s', self.branch.base,
2840
 
            self.branch._format)
2841
 
        for error in self.errors:
2842
 
            note('found error:%s', error)
 
2388
        note('checked branch %s format %s',
 
2389
             self.branch.base,
 
2390
             self.branch._format)
2843
2391
 
2844
2392
 
2845
2393
class Converter5to6(object):
2881
2429
        branch._set_config_location('stacked_on_location', '')
2882
2430
        # update target format
2883
2431
        branch._transport.put_bytes('format', format.get_format_string())
2884
 
 
2885
 
 
2886
 
class Converter7to8(object):
2887
 
    """Perform an in-place upgrade of format 6 to format 7"""
2888
 
 
2889
 
    def convert(self, branch):
2890
 
        format = BzrBranchFormat8()
2891
 
        branch._transport.put_bytes('references', '')
2892
 
        # update target format
2893
 
        branch._transport.put_bytes('format', format.get_format_string())
2894
 
 
2895
 
 
2896
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2897
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2898
 
    duration.
2899
 
 
2900
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
2901
 
 
2902
 
    If an exception is raised by callable, then that exception *will* be
2903
 
    propagated, even if the unlock attempt raises its own error.  Thus
2904
 
    _run_with_write_locked_target should be preferred to simply doing::
2905
 
 
2906
 
        target.lock_write()
2907
 
        try:
2908
 
            return callable(*args, **kwargs)
2909
 
        finally:
2910
 
            target.unlock()
2911
 
 
2912
 
    """
2913
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
2914
 
    # should share code?
2915
 
    target.lock_write()
2916
 
    try:
2917
 
        result = callable(*args, **kwargs)
2918
 
    except:
2919
 
        exc_info = sys.exc_info()
2920
 
        try:
2921
 
            target.unlock()
2922
 
        finally:
2923
 
            raise exc_info[0], exc_info[1], exc_info[2]
2924
 
    else:
2925
 
        target.unlock()
2926
 
        return result
2927
 
 
2928
 
 
2929
 
class InterBranch(InterObject):
2930
 
    """This class represents operations taking place between two branches.
2931
 
 
2932
 
    Its instances have methods like pull() and push() and contain
2933
 
    references to the source and target repositories these operations
2934
 
    can be carried out on.
2935
 
    """
2936
 
 
2937
 
    _optimisers = []
2938
 
    """The available optimised InterBranch types."""
2939
 
 
2940
 
    @staticmethod
2941
 
    def _get_branch_formats_to_test():
2942
 
        """Return a tuple with the Branch formats to use when testing."""
2943
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2944
 
 
2945
 
    def pull(self, overwrite=False, stop_revision=None,
2946
 
             possible_transports=None, local=False):
2947
 
        """Mirror source into target branch.
2948
 
 
2949
 
        The target branch is considered to be 'local', having low latency.
2950
 
 
2951
 
        :returns: PullResult instance
2952
 
        """
2953
 
        raise NotImplementedError(self.pull)
2954
 
 
2955
 
    def update_revisions(self, stop_revision=None, overwrite=False,
2956
 
                         graph=None):
2957
 
        """Pull in new perfect-fit revisions.
2958
 
 
2959
 
        :param stop_revision: Updated until the given revision
2960
 
        :param overwrite: Always set the branch pointer, rather than checking
2961
 
            to see if it is a proper descendant.
2962
 
        :param graph: A Graph object that can be used to query history
2963
 
            information. This can be None.
2964
 
        :return: None
2965
 
        """
2966
 
        raise NotImplementedError(self.update_revisions)
2967
 
 
2968
 
    def push(self, overwrite=False, stop_revision=None,
2969
 
             _override_hook_source_branch=None):
2970
 
        """Mirror the source branch into the target branch.
2971
 
 
2972
 
        The source branch is considered to be 'local', having low latency.
2973
 
        """
2974
 
        raise NotImplementedError(self.push)
2975
 
 
2976
 
 
2977
 
class GenericInterBranch(InterBranch):
2978
 
    """InterBranch implementation that uses public Branch functions.
2979
 
    """
2980
 
 
2981
 
    @staticmethod
2982
 
    def _get_branch_formats_to_test():
2983
 
        return BranchFormat._default_format, BranchFormat._default_format
2984
 
 
2985
 
    def update_revisions(self, stop_revision=None, overwrite=False,
2986
 
        graph=None):
2987
 
        """See InterBranch.update_revisions()."""
2988
 
        self.source.lock_read()
2989
 
        try:
2990
 
            other_revno, other_last_revision = self.source.last_revision_info()
2991
 
            stop_revno = None # unknown
2992
 
            if stop_revision is None:
2993
 
                stop_revision = other_last_revision
2994
 
                if _mod_revision.is_null(stop_revision):
2995
 
                    # if there are no commits, we're done.
2996
 
                    return
2997
 
                stop_revno = other_revno
2998
 
 
2999
 
            # what's the current last revision, before we fetch [and change it
3000
 
            # possibly]
3001
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3002
 
            # we fetch here so that we don't process data twice in the common
3003
 
            # case of having something to pull, and so that the check for
3004
 
            # already merged can operate on the just fetched graph, which will
3005
 
            # be cached in memory.
3006
 
            self.target.fetch(self.source, stop_revision)
3007
 
            # Check to see if one is an ancestor of the other
3008
 
            if not overwrite:
3009
 
                if graph is None:
3010
 
                    graph = self.target.repository.get_graph()
3011
 
                if self.target._check_if_descendant_or_diverged(
3012
 
                        stop_revision, last_rev, graph, self.source):
3013
 
                    # stop_revision is a descendant of last_rev, but we aren't
3014
 
                    # overwriting, so we're done.
3015
 
                    return
3016
 
            if stop_revno is None:
3017
 
                if graph is None:
3018
 
                    graph = self.target.repository.get_graph()
3019
 
                this_revno, this_last_revision = \
3020
 
                        self.target.last_revision_info()
3021
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3022
 
                                [(other_last_revision, other_revno),
3023
 
                                 (this_last_revision, this_revno)])
3024
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3025
 
        finally:
3026
 
            self.source.unlock()
3027
 
 
3028
 
    def pull(self, overwrite=False, stop_revision=None,
3029
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3030
 
             _override_hook_target=None, local=False):
3031
 
        """See Branch.pull.
3032
 
 
3033
 
        :param _hook_master: Private parameter - set the branch to
3034
 
            be supplied as the master to pull hooks.
3035
 
        :param run_hooks: Private parameter - if false, this branch
3036
 
            is being called because it's the master of the primary branch,
3037
 
            so it should not run its hooks.
3038
 
        :param _override_hook_target: Private parameter - set the branch to be
3039
 
            supplied as the target_branch to pull hooks.
3040
 
        :param local: Only update the local branch, and not the bound branch.
3041
 
        """
3042
 
        # This type of branch can't be bound.
3043
 
        if local:
3044
 
            raise errors.LocalRequiresBoundBranch()
3045
 
        result = PullResult()
3046
 
        result.source_branch = self.source
3047
 
        if _override_hook_target is None:
3048
 
            result.target_branch = self.target
3049
 
        else:
3050
 
            result.target_branch = _override_hook_target
3051
 
        self.source.lock_read()
3052
 
        try:
3053
 
            # We assume that during 'pull' the target repository is closer than
3054
 
            # the source one.
3055
 
            self.source.update_references(self.target)
3056
 
            graph = self.target.repository.get_graph(self.source.repository)
3057
 
            # TODO: Branch formats should have a flag that indicates 
3058
 
            # that revno's are expensive, and pull() should honor that flag.
3059
 
            # -- JRV20090506
3060
 
            result.old_revno, result.old_revid = \
3061
 
                self.target.last_revision_info()
3062
 
            self.target.update_revisions(self.source, stop_revision,
3063
 
                overwrite=overwrite, graph=graph)
3064
 
            # TODO: The old revid should be specified when merging tags, 
3065
 
            # so a tags implementation that versions tags can only 
3066
 
            # pull in the most recent changes. -- JRV20090506
3067
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3068
 
                overwrite)
3069
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3070
 
            if _hook_master:
3071
 
                result.master_branch = _hook_master
3072
 
                result.local_branch = result.target_branch
3073
 
            else:
3074
 
                result.master_branch = result.target_branch
3075
 
                result.local_branch = None
3076
 
            if run_hooks:
3077
 
                for hook in Branch.hooks['post_pull']:
3078
 
                    hook(result)
3079
 
        finally:
3080
 
            self.source.unlock()
3081
 
        return result
3082
 
 
3083
 
    def push(self, overwrite=False, stop_revision=None,
3084
 
             _override_hook_source_branch=None):
3085
 
        """See InterBranch.push.
3086
 
 
3087
 
        This is the basic concrete implementation of push()
3088
 
 
3089
 
        :param _override_hook_source_branch: If specified, run
3090
 
        the hooks passing this Branch as the source, rather than self.
3091
 
        This is for use of RemoteBranch, where push is delegated to the
3092
 
        underlying vfs-based Branch.
3093
 
        """
3094
 
        # TODO: Public option to disable running hooks - should be trivial but
3095
 
        # needs tests.
3096
 
        self.source.lock_read()
3097
 
        try:
3098
 
            return _run_with_write_locked_target(
3099
 
                self.target, self._push_with_bound_branches, overwrite,
3100
 
                stop_revision,
3101
 
                _override_hook_source_branch=_override_hook_source_branch)
3102
 
        finally:
3103
 
            self.source.unlock()
3104
 
 
3105
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3106
 
            _override_hook_source_branch=None):
3107
 
        """Push from source into target, and into target's master if any.
3108
 
        """
3109
 
        def _run_hooks():
3110
 
            if _override_hook_source_branch:
3111
 
                result.source_branch = _override_hook_source_branch
3112
 
            for hook in Branch.hooks['post_push']:
3113
 
                hook(result)
3114
 
 
3115
 
        bound_location = self.target.get_bound_location()
3116
 
        if bound_location and self.target.base != bound_location:
3117
 
            # there is a master branch.
3118
 
            #
3119
 
            # XXX: Why the second check?  Is it even supported for a branch to
3120
 
            # be bound to itself? -- mbp 20070507
3121
 
            master_branch = self.target.get_master_branch()
3122
 
            master_branch.lock_write()
3123
 
            try:
3124
 
                # push into the master from the source branch.
3125
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3126
 
                # and push into the target branch from the source. Note that we
3127
 
                # push from the source branch again, because its considered the
3128
 
                # highest bandwidth repository.
3129
 
                result = self.source._basic_push(self.target, overwrite,
3130
 
                    stop_revision)
3131
 
                result.master_branch = master_branch
3132
 
                result.local_branch = self.target
3133
 
                _run_hooks()
3134
 
                return result
3135
 
            finally:
3136
 
                master_branch.unlock()
3137
 
        else:
3138
 
            # no master branch
3139
 
            result = self.source._basic_push(self.target, overwrite,
3140
 
                stop_revision)
3141
 
            # TODO: Why set master_branch and local_branch if there's no
3142
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3143
 
            # 20070504
3144
 
            result.master_branch = self.target
3145
 
            result.local_branch = None
3146
 
            _run_hooks()
3147
 
            return result
3148
 
 
3149
 
    @classmethod
3150
 
    def is_compatible(self, source, target):
3151
 
        # GenericBranch uses the public API, so always compatible
3152
 
        return True
3153
 
 
3154
 
 
3155
 
class InterToBranch5(GenericInterBranch):
3156
 
 
3157
 
    @staticmethod
3158
 
    def _get_branch_formats_to_test():
3159
 
        return BranchFormat._default_format, BzrBranchFormat5()
3160
 
 
3161
 
    def pull(self, overwrite=False, stop_revision=None,
3162
 
             possible_transports=None, run_hooks=True,
3163
 
             _override_hook_target=None, local=False):
3164
 
        """Pull from source into self, updating my master if any.
3165
 
 
3166
 
        :param run_hooks: Private parameter - if false, this branch
3167
 
            is being called because it's the master of the primary branch,
3168
 
            so it should not run its hooks.
3169
 
        """
3170
 
        bound_location = self.target.get_bound_location()
3171
 
        if local and not bound_location:
3172
 
            raise errors.LocalRequiresBoundBranch()
3173
 
        master_branch = None
3174
 
        if not local and bound_location and self.source.base != bound_location:
3175
 
            # not pulling from master, so we need to update master.
3176
 
            master_branch = self.target.get_master_branch(possible_transports)
3177
 
            master_branch.lock_write()
3178
 
        try:
3179
 
            if master_branch:
3180
 
                # pull from source into master.
3181
 
                master_branch.pull(self.source, overwrite, stop_revision,
3182
 
                    run_hooks=False)
3183
 
            return super(InterToBranch5, self).pull(overwrite,
3184
 
                stop_revision, _hook_master=master_branch,
3185
 
                run_hooks=run_hooks,
3186
 
                _override_hook_target=_override_hook_target)
3187
 
        finally:
3188
 
            if master_branch:
3189
 
                master_branch.unlock()
3190
 
 
3191
 
 
3192
 
InterBranch.register_optimiser(GenericInterBranch)
3193
 
InterBranch.register_optimiser(InterToBranch5)