~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Ferlito
  • Date: 2009-09-02 04:31:45 UTC
  • mto: (4665.7.1 serve-init)
  • mto: This revision was merged to the branch mainline in revision 4913.
  • Revision ID: johnf@inodes.org-20090902043145-gxdsfw03ilcwbyn5
Add a debian init script for bzr --serve

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
from cStringIO import StringIO
18
19
import sys
19
20
 
20
21
from bzrlib.lazy_import import lazy_import
30
31
        lockable_files,
31
32
        repository,
32
33
        revision as _mod_revision,
 
34
        rio,
 
35
        symbol_versioning,
33
36
        transport,
34
37
        tsort,
35
38
        ui,
36
39
        urlutils,
37
40
        )
38
 
from bzrlib.config import BranchConfig
39
 
from bzrlib.repofmt.pack_repo import RepositoryFormatPackDevelopment1Subtree
 
41
from bzrlib.config import BranchConfig, TransportConfig
 
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
43
from bzrlib.tag import (
41
44
    BasicTags,
42
45
    DisabledTags,
44
47
""")
45
48
 
46
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
 
from bzrlib.hooks import Hooks
 
50
from bzrlib.hooks import HookPoint, Hooks
 
51
from bzrlib.inter import InterObject
 
52
from bzrlib import registry
48
53
from bzrlib.symbol_versioning import (
49
54
    deprecated_in,
50
55
    deprecated_method,
81
86
    # - RBC 20060112
82
87
    base = None
83
88
 
84
 
    # override this to set the strategy for storing tags
85
 
    def _make_tags(self):
86
 
        return DisabledTags(self)
87
 
 
88
89
    def __init__(self, *ignored, **ignored_too):
89
 
        self.tags = self._make_tags()
 
90
        self.tags = self._format.make_tags(self)
90
91
        self._revision_history_cache = None
91
92
        self._revision_id_to_revno_cache = None
 
93
        self._partial_revision_id_to_revno_cache = {}
 
94
        self._partial_revision_history_cache = []
92
95
        self._last_revision_info_cache = None
 
96
        self._merge_sorted_revisions_cache = None
93
97
        self._open_hook()
 
98
        hooks = Branch.hooks['open']
 
99
        for hook in hooks:
 
100
            hook(self)
94
101
 
95
102
    def _open_hook(self):
96
103
        """Called by init to allow simpler extension of the base class."""
97
104
 
 
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
 
98
112
    def break_lock(self):
99
113
        """Break a lock if one is present from another instance.
100
114
 
109
123
        if master is not None:
110
124
            master.break_lock()
111
125
 
 
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
 
112
160
    @staticmethod
113
161
    def open(base, _unsupported=False, possible_transports=None):
114
162
        """Open the branch rooted at base.
129
177
    @staticmethod
130
178
    def open_containing(url, possible_transports=None):
131
179
        """Open an existing branch which contains url.
132
 
        
 
180
 
133
181
        This probes for a branch at url, and searches upwards from there.
134
182
 
135
183
        Basically we keep looking up until we find the control directory or
136
184
        run into the root.  If there isn't one, raises NotBranchError.
137
 
        If there is one and it is either an unrecognised format or an unsupported 
 
185
        If there is one and it is either an unrecognised format or an unsupported
138
186
        format, UnknownFormatError or UnsupportedFormatError are raised.
139
187
        If there is one, it is returned, along with the unused portion of url.
140
188
        """
142
190
                                                         possible_transports)
143
191
        return control.open_branch(), relpath
144
192
 
 
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
 
145
201
    def get_config(self):
146
202
        return BranchConfig(self)
147
203
 
148
 
    def _get_nick(self):
149
 
        return self.get_config().get_nickname()
 
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()
150
252
 
151
253
    def _set_nick(self, nick):
152
254
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
156
258
    def is_locked(self):
157
259
        raise NotImplementedError(self.is_locked)
158
260
 
 
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
 
159
288
    def lock_write(self):
160
289
        raise NotImplementedError(self.lock_write)
161
290
 
173
302
        raise NotImplementedError(self.get_physical_lock_status)
174
303
 
175
304
    @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
176
369
    def get_revision_id_to_revno_map(self):
177
370
        """Return the revision_id => dotted revno map.
178
371
 
202
395
 
203
396
        :return: A dictionary mapping revision_id => dotted revno.
204
397
        """
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)
213
398
        revision_id_to_revno = dict((rev_id, revno)
214
 
                                    for seq_num, rev_id, depth, revno, end_of_merge
215
 
                                     in merge_sorted_revisions)
 
399
            for rev_id, depth, revno, end_of_merge
 
400
             in self.iter_merge_sorted_revisions())
216
401
        return revision_id_to_revno
217
402
 
 
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
            last_key = (last_revision,)
 
450
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
451
                [last_key])
 
452
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
 
453
                last_key)
 
454
        filtered = self._filter_merge_sorted_revisions(
 
455
            self._merge_sorted_revisions_cache, start_revision_id,
 
456
            stop_revision_id, stop_rule)
 
457
        if direction == 'reverse':
 
458
            return filtered
 
459
        if direction == 'forward':
 
460
            return reversed(list(filtered))
 
461
        else:
 
462
            raise ValueError('invalid direction %r' % direction)
 
463
 
 
464
    def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
 
465
        start_revision_id, stop_revision_id, stop_rule):
 
466
        """Iterate over an inclusive range of sorted revisions."""
 
467
        rev_iter = iter(merge_sorted_revisions)
 
468
        if start_revision_id is not None:
 
469
            for node in rev_iter:
 
470
                rev_id = node.key[-1]
 
471
                if rev_id != start_revision_id:
 
472
                    continue
 
473
                else:
 
474
                    # The decision to include the start or not
 
475
                    # depends on the stop_rule if a stop is provided
 
476
                    # so pop this node back into the iterator
 
477
                    rev_iter = chain(iter([node]), rev_iter)
 
478
                    break
 
479
        if stop_revision_id is None:
 
480
            # Yield everything
 
481
            for node in rev_iter:
 
482
                rev_id = node.key[-1]
 
483
                yield (rev_id, node.merge_depth, node.revno,
 
484
                       node.end_of_merge)
 
485
        elif stop_rule == 'exclude':
 
486
            for node in rev_iter:
 
487
                rev_id = node.key[-1]
 
488
                if rev_id == stop_revision_id:
 
489
                    return
 
490
                yield (rev_id, node.merge_depth, node.revno,
 
491
                       node.end_of_merge)
 
492
        elif stop_rule == 'include':
 
493
            for node in rev_iter:
 
494
                rev_id = node.key[-1]
 
495
                yield (rev_id, node.merge_depth, node.revno,
 
496
                       node.end_of_merge)
 
497
                if rev_id == stop_revision_id:
 
498
                    return
 
499
        elif stop_rule == 'with-merges':
 
500
            stop_rev = self.repository.get_revision(stop_revision_id)
 
501
            if stop_rev.parent_ids:
 
502
                left_parent = stop_rev.parent_ids[0]
 
503
            else:
 
504
                left_parent = _mod_revision.NULL_REVISION
 
505
            for node in rev_iter:
 
506
                rev_id = node.key[-1]
 
507
                if rev_id == left_parent:
 
508
                    return
 
509
                yield (rev_id, node.merge_depth, node.revno,
 
510
                       node.end_of_merge)
 
511
        else:
 
512
            raise ValueError('invalid stop_rule %r' % stop_rule)
 
513
 
218
514
    def leave_lock_in_place(self):
219
515
        """Tell this branch object not to release the physical lock when this
220
516
        object is unlocked.
221
 
        
 
517
 
222
518
        If lock_write doesn't return a token, then this method is not supported.
223
519
        """
224
520
        self.control_files.leave_in_place()
239
535
        """
240
536
        raise errors.UpgradeRequired(self.base)
241
537
 
 
538
    def set_append_revisions_only(self, enabled):
 
539
        if not self._format.supports_set_append_revisions_only():
 
540
            raise errors.UpgradeRequired(self.base)
 
541
        if enabled:
 
542
            value = 'True'
 
543
        else:
 
544
            value = 'False'
 
545
        self.get_config().set_user_option('append_revisions_only', value,
 
546
            warn_masked=True)
 
547
 
 
548
    def set_reference_info(self, file_id, tree_path, branch_location):
 
549
        """Set the branch location to use for a tree reference."""
 
550
        raise errors.UnsupportedOperation(self.set_reference_info, self)
 
551
 
 
552
    def get_reference_info(self, file_id):
 
553
        """Get the tree_path and branch_location for a tree reference."""
 
554
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
555
 
242
556
    @needs_write_lock
243
557
    def fetch(self, from_branch, last_revision=None, pb=None):
244
558
        """Copy revisions from from_branch into this branch.
247
561
        :param last_revision: What revision to stop at (None for at the end
248
562
                              of the branch.
249
563
        :param pb: An optional progress bar to use.
250
 
 
251
 
        Returns the copied revision count and the failed revisions in a tuple:
252
 
        (copied, failures).
 
564
        :return: None
253
565
        """
254
566
        if self.base == from_branch.base:
255
567
            return (0, [])
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
 
 
 
568
        if pb is not None:
 
569
            symbol_versioning.warn(
 
570
                symbol_versioning.deprecated_in((1, 14, 0))
 
571
                % "pb parameter to fetch()")
262
572
        from_branch.lock_read()
263
573
        try:
264
574
            if last_revision is None:
265
 
                pb.update('get source history')
266
575
                last_revision = from_branch.last_revision()
267
576
                last_revision = _mod_revision.ensure_null(last_revision)
268
577
            return self.repository.fetch(from_branch.repository,
269
578
                                         revision_id=last_revision,
270
 
                                         pb=nested_pb)
 
579
                                         pb=pb)
271
580
        finally:
272
 
            if nested_pb is not None:
273
 
                nested_pb.finished()
274
581
            from_branch.unlock()
275
582
 
276
583
    def get_bound_location(self):
280
587
        branch.
281
588
        """
282
589
        return None
283
 
    
 
590
 
284
591
    def get_old_bound_location(self):
285
592
        """Return the URL of the branch we used to be bound to
286
593
        """
287
594
        raise errors.UpgradeRequired(self.base)
288
595
 
289
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
290
 
                           timezone=None, committer=None, revprops=None, 
 
596
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
597
                           timezone=None, committer=None, revprops=None,
291
598
                           revision_id=None):
292
599
        """Obtain a CommitBuilder for this branch.
293
 
        
 
600
 
294
601
        :param parents: Revision ids of the parents of the new revision.
295
602
        :param config: Optional configuration to use.
296
603
        :param timestamp: Optional timestamp recorded for commit.
302
609
 
303
610
        if config is None:
304
611
            config = self.get_config()
305
 
        
 
612
 
306
613
        return self.repository.get_commit_builder(self, parents, config,
307
614
            timestamp, timezone, committer, revprops, revision_id)
308
615
 
309
616
    def get_master_branch(self, possible_transports=None):
310
617
        """Return the branch we are bound to.
311
 
        
 
618
 
312
619
        :return: Either a Branch, or None
313
620
        """
314
621
        return None
340
647
    def set_revision_history(self, rev_history):
341
648
        raise NotImplementedError(self.set_revision_history)
342
649
 
 
650
    @needs_write_lock
 
651
    def set_parent(self, url):
 
652
        """See Branch.set_parent."""
 
653
        # TODO: Maybe delete old location files?
 
654
        # URLs should never be unicode, even on the local fs,
 
655
        # FIXUP this and get_parent in a future branch format bump:
 
656
        # read and rewrite the file. RBC 20060125
 
657
        if url is not None:
 
658
            if isinstance(url, unicode):
 
659
                try:
 
660
                    url = url.encode('ascii')
 
661
                except UnicodeEncodeError:
 
662
                    raise errors.InvalidURL(url,
 
663
                        "Urls must be 7-bit ascii, "
 
664
                        "use bzrlib.urlutils.escape")
 
665
            url = urlutils.relative_url(self.base, url)
 
666
        self._set_parent_location(url)
 
667
 
 
668
    @needs_write_lock
343
669
    def set_stacked_on_url(self, url):
344
670
        """Set the URL this branch is stacked against.
345
671
 
348
674
        :raises UnstackableRepositoryFormat: If the repository does not support
349
675
            stacking.
350
676
        """
351
 
        raise NotImplementedError(self.set_stacked_on_url)
 
677
        if not self._format.supports_stacking():
 
678
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
679
        # XXX: Changing from one fallback repository to another does not check
 
680
        # that all the data you need is present in the new fallback.
 
681
        # Possibly it should.
 
682
        self._check_stackable_repo()
 
683
        if not url:
 
684
            try:
 
685
                old_url = self.get_stacked_on_url()
 
686
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
687
                errors.UnstackableRepositoryFormat):
 
688
                return
 
689
            self._unstack()
 
690
        else:
 
691
            self._activate_fallback_location(url)
 
692
        # write this out after the repository is stacked to avoid setting a
 
693
        # stacked config that doesn't work.
 
694
        self._set_config_location('stacked_on_location', url)
 
695
 
 
696
    def _unstack(self):
 
697
        """Change a branch to be unstacked, copying data as needed.
 
698
        
 
699
        Don't call this directly, use set_stacked_on_url(None).
 
700
        """
 
701
        pb = ui.ui_factory.nested_progress_bar()
 
702
        try:
 
703
            pb.update("Unstacking")
 
704
            # The basic approach here is to fetch the tip of the branch,
 
705
            # including all available ghosts, from the existing stacked
 
706
            # repository into a new repository object without the fallbacks. 
 
707
            #
 
708
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
 
709
            # correct for CHKMap repostiories
 
710
            old_repository = self.repository
 
711
            if len(old_repository._fallback_repositories) != 1:
 
712
                raise AssertionError("can't cope with fallback repositories "
 
713
                    "of %r" % (self.repository,))
 
714
            # unlock it, including unlocking the fallback
 
715
            old_repository.unlock()
 
716
            old_repository.lock_read()
 
717
            try:
 
718
                # Repositories don't offer an interface to remove fallback
 
719
                # repositories today; take the conceptually simpler option and just
 
720
                # reopen it.  We reopen it starting from the URL so that we
 
721
                # get a separate connection for RemoteRepositories and can
 
722
                # stream from one of them to the other.  This does mean doing
 
723
                # separate SSH connection setup, but unstacking is not a
 
724
                # common operation so it's tolerable.
 
725
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
726
                new_repository = new_bzrdir.find_repository()
 
727
                self.repository = new_repository
 
728
                if self.repository._fallback_repositories:
 
729
                    raise AssertionError("didn't expect %r to have "
 
730
                        "fallback_repositories"
 
731
                        % (self.repository,))
 
732
                # this is not paired with an unlock because it's just restoring
 
733
                # the previous state; the lock's released when set_stacked_on_url
 
734
                # returns
 
735
                self.repository.lock_write()
 
736
                # XXX: If you unstack a branch while it has a working tree
 
737
                # with a pending merge, the pending-merged revisions will no
 
738
                # longer be present.  You can (probably) revert and remerge.
 
739
                #
 
740
                # XXX: This only fetches up to the tip of the repository; it
 
741
                # doesn't bring across any tags.  That's fairly consistent
 
742
                # with how branch works, but perhaps not ideal.
 
743
                self.repository.fetch(old_repository,
 
744
                    revision_id=self.last_revision(),
 
745
                    find_ghosts=True)
 
746
            finally:
 
747
                old_repository.unlock()
 
748
        finally:
 
749
            pb.finished()
 
750
 
 
751
    def _set_tags_bytes(self, bytes):
 
752
        """Mirror method for _get_tags_bytes.
 
753
 
 
754
        :seealso: Branch._get_tags_bytes.
 
755
        """
 
756
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
757
            'tags', bytes)
352
758
 
353
759
    def _cache_revision_history(self, rev_history):
354
760
        """Set the cached revision history to rev_history.
381
787
        self._revision_history_cache = None
382
788
        self._revision_id_to_revno_cache = None
383
789
        self._last_revision_info_cache = None
 
790
        self._merge_sorted_revisions_cache = None
 
791
        self._partial_revision_history_cache = []
 
792
        self._partial_revision_id_to_revno_cache = {}
384
793
 
385
794
    def _gen_revision_history(self):
386
795
        """Return sequence of revision hashes on to this branch.
387
 
        
 
796
 
388
797
        Unlike revision_history, this method always regenerates or rereads the
389
798
        revision history, i.e. it does not cache the result, so repeated calls
390
799
        may be expensive.
391
800
 
392
801
        Concrete subclasses should override this instead of revision_history so
393
802
        that subclasses do not need to deal with caching logic.
394
 
        
 
803
 
395
804
        This API is semi-public; it only for use by subclasses, all other code
396
805
        should consider it to be private.
397
806
        """
400
809
    @needs_read_lock
401
810
    def revision_history(self):
402
811
        """Return sequence of revision ids on this branch.
403
 
        
 
812
 
404
813
        This method will cache the revision history for as long as it is safe to
405
814
        do so.
406
815
        """
425
834
        """Older format branches cannot bind or unbind."""
426
835
        raise errors.UpgradeRequired(self.base)
427
836
 
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
 
 
432
837
    def last_revision(self):
433
838
        """Return last revision id, or NULL_REVISION."""
434
839
        return self.last_revision_info()[1]
454
859
    @deprecated_method(deprecated_in((1, 6, 0)))
455
860
    def missing_revisions(self, other, stop_revision=None):
456
861
        """Return a list of new revisions that would perfectly fit.
457
 
        
 
862
 
458
863
        If self and other have not diverged, return a list of the revisions
459
864
        present in other, but missing from self.
460
865
        """
487
892
            information. This can be None.
488
893
        :return: None
489
894
        """
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()
 
895
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
896
            overwrite, graph)
 
897
 
 
898
    def import_last_revision_info(self, source_repo, revno, revid):
 
899
        """Set the last revision info, importing from another repo if necessary.
 
900
 
 
901
        This is used by the bound branch code to upload a revision to
 
902
        the master branch first before updating the tip of the local branch.
 
903
 
 
904
        :param source_repo: Source repository to optionally fetch from
 
905
        :param revno: Revision number of the new tip
 
906
        :param revid: Revision id of the new tip
 
907
        """
 
908
        if not self.repository.has_same_location(source_repo):
 
909
            self.repository.fetch(source_repo, revision_id=revid)
 
910
        self.set_last_revision_info(revno, revid)
528
911
 
529
912
    def revision_id_to_revno(self, revision_id):
530
913
        """Given a revision id, return its revno"""
536
919
        except ValueError:
537
920
            raise errors.NoSuchRevision(self, revision_id)
538
921
 
 
922
    @needs_read_lock
539
923
    def get_rev_id(self, revno, history=None):
540
924
        """Find the revision id of the specified revno."""
541
925
        if revno == 0:
542
926
            return _mod_revision.NULL_REVISION
543
 
        if history is None:
544
 
            history = self.revision_history()
545
 
        if revno <= 0 or revno > len(history):
 
927
        last_revno, last_revid = self.last_revision_info()
 
928
        if revno == last_revno:
 
929
            return last_revid
 
930
        if revno <= 0 or revno > last_revno:
546
931
            raise errors.NoSuchRevision(self, revno)
547
 
        return history[revno - 1]
 
932
        distance_from_last = last_revno - revno
 
933
        if len(self._partial_revision_history_cache) <= distance_from_last:
 
934
            self._extend_partial_history(distance_from_last)
 
935
        return self._partial_revision_history_cache[distance_from_last]
548
936
 
 
937
    @needs_write_lock
549
938
    def pull(self, source, overwrite=False, stop_revision=None,
550
 
             possible_transports=None, _override_hook_target=None):
 
939
             possible_transports=None, *args, **kwargs):
551
940
        """Mirror source into this branch.
552
941
 
553
942
        This branch is considered to be 'local', having low latency.
554
943
 
555
944
        :returns: PullResult instance
556
945
        """
557
 
        raise NotImplementedError(self.pull)
 
946
        return InterBranch.get(source, self).pull(overwrite=overwrite,
 
947
            stop_revision=stop_revision,
 
948
            possible_transports=possible_transports, *args, **kwargs)
558
949
 
559
 
    def push(self, target, overwrite=False, stop_revision=None):
 
950
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
951
        **kwargs):
560
952
        """Mirror this branch into target.
561
953
 
562
954
        This branch is considered to be 'local', having low latency.
563
955
        """
564
 
        raise NotImplementedError(self.push)
 
956
        return InterBranch.get(self, target).push(overwrite, stop_revision,
 
957
            *args, **kwargs)
 
958
 
 
959
    def lossy_push(self, target, stop_revision=None):
 
960
        """Push deltas into another branch.
 
961
 
 
962
        :note: This does not, like push, retain the revision ids from 
 
963
            the source branch and will, rather than adding bzr-specific 
 
964
            metadata, push only those semantics of the revision that can be 
 
965
            natively represented by this branch' VCS.
 
966
 
 
967
        :param target: Target branch
 
968
        :param stop_revision: Revision to push, defaults to last revision.
 
969
        :return: BranchPushResult with an extra member revidmap: 
 
970
            A dictionary mapping revision ids from the target branch 
 
971
            to new revision ids in the target branch, for each 
 
972
            revision that was pushed.
 
973
        """
 
974
        inter = InterBranch.get(self, target)
 
975
        lossy_push = getattr(inter, "lossy_push", None)
 
976
        if lossy_push is None:
 
977
            raise errors.LossyPushToSameVCS(self, target)
 
978
        return lossy_push(stop_revision)
565
979
 
566
980
    def basis_tree(self):
567
981
        """Return `Tree` object for last revision."""
570
984
    def get_parent(self):
571
985
        """Return the parent location of the branch.
572
986
 
573
 
        This is the default location for push/pull/missing.  The usual
 
987
        This is the default location for pull/missing.  The usual
574
988
        pattern is that the user can override it by specifying a
575
989
        location.
576
990
        """
577
 
        raise NotImplementedError(self.get_parent)
 
991
        parent = self._get_parent_location()
 
992
        if parent is None:
 
993
            return parent
 
994
        # This is an old-format absolute path to a local branch
 
995
        # turn it into a url
 
996
        if parent.startswith('/'):
 
997
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
998
        try:
 
999
            return urlutils.join(self.base[:-1], parent)
 
1000
        except errors.InvalidURLJoin, e:
 
1001
            raise errors.InaccessibleParent(parent, self.base)
 
1002
 
 
1003
    def _get_parent_location(self):
 
1004
        raise NotImplementedError(self._get_parent_location)
578
1005
 
579
1006
    def _set_config_location(self, name, url, config=None,
580
1007
                             make_relative=False):
594
1021
            location = None
595
1022
        return location
596
1023
 
 
1024
    def get_child_submit_format(self):
 
1025
        """Return the preferred format of submissions to this branch."""
 
1026
        return self.get_config().get_user_option("child_submit_format")
 
1027
 
597
1028
    def get_submit_branch(self):
598
1029
        """Return the submit location of the branch.
599
1030
 
616
1047
    def get_public_branch(self):
617
1048
        """Return the public location of the branch.
618
1049
 
619
 
        This is is used by merge directives.
 
1050
        This is used by merge directives.
620
1051
        """
621
1052
        return self._get_config_location('public_branch')
622
1053
 
638
1069
        """Set a new push location for this branch."""
639
1070
        raise NotImplementedError(self.set_push_location)
640
1071
 
641
 
    def set_parent(self, url):
642
 
        raise NotImplementedError(self.set_parent)
 
1072
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1073
        """Run the post_change_branch_tip hooks."""
 
1074
        hooks = Branch.hooks['post_change_branch_tip']
 
1075
        if not hooks:
 
1076
            return
 
1077
        new_revno, new_revid = self.last_revision_info()
 
1078
        params = ChangeBranchTipParams(
 
1079
            self, old_revno, new_revno, old_revid, new_revid)
 
1080
        for hook in hooks:
 
1081
            hook(params)
 
1082
 
 
1083
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1084
        """Run the pre_change_branch_tip hooks."""
 
1085
        hooks = Branch.hooks['pre_change_branch_tip']
 
1086
        if not hooks:
 
1087
            return
 
1088
        old_revno, old_revid = self.last_revision_info()
 
1089
        params = ChangeBranchTipParams(
 
1090
            self, old_revno, new_revno, old_revid, new_revid)
 
1091
        for hook in hooks:
 
1092
            try:
 
1093
                hook(params)
 
1094
            except errors.TipChangeRejected:
 
1095
                raise
 
1096
            except Exception:
 
1097
                exc_info = sys.exc_info()
 
1098
                hook_name = Branch.hooks.get_hook_name(hook)
 
1099
                raise errors.HookFailed(
 
1100
                    'pre_change_branch_tip', hook_name, exc_info)
643
1101
 
644
1102
    @needs_write_lock
645
1103
    def update(self):
646
 
        """Synchronise this branch with the master branch if any. 
 
1104
        """Synchronise this branch with the master branch if any.
647
1105
 
648
1106
        :return: None or the last_revision pivoted out during the update.
649
1107
        """
656
1114
        """
657
1115
        if revno != 0:
658
1116
            self.check_real_revno(revno)
659
 
            
 
1117
 
660
1118
    def check_real_revno(self, revno):
661
1119
        """\
662
1120
        Check whether a revno corresponds to a real revision.
666
1124
            raise errors.InvalidRevisionNumber(revno)
667
1125
 
668
1126
    @needs_read_lock
669
 
    def clone(self, to_bzrdir, revision_id=None):
 
1127
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
670
1128
        """Clone this branch into to_bzrdir preserving all semantic values.
671
 
        
 
1129
 
 
1130
        Most API users will want 'create_clone_on_transport', which creates a
 
1131
        new bzrdir and branch on the fly.
 
1132
 
672
1133
        revision_id: if not None, the revision history in the new branch will
673
1134
                     be truncated to end with revision_id.
674
1135
        """
675
1136
        result = to_bzrdir.create_branch()
676
 
        self.copy_content_into(result, revision_id=revision_id)
677
 
        return  result
 
1137
        result.lock_write()
 
1138
        try:
 
1139
            if repository_policy is not None:
 
1140
                repository_policy.configure_branch(result)
 
1141
            self.copy_content_into(result, revision_id=revision_id)
 
1142
        finally:
 
1143
            result.unlock()
 
1144
        return result
678
1145
 
679
1146
    @needs_read_lock
680
 
    def sprout(self, to_bzrdir, revision_id=None):
 
1147
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
681
1148
        """Create a new line of development from the branch, into to_bzrdir.
682
1149
 
683
1150
        to_bzrdir controls the branch format.
685
1152
        revision_id: if not None, the revision history in the new branch will
686
1153
                     be truncated to end with revision_id.
687
1154
        """
 
1155
        if (repository_policy is not None and
 
1156
            repository_policy.requires_stacking()):
 
1157
            to_bzrdir._format.require_stacking(_skip_repo=True)
688
1158
        result = to_bzrdir.create_branch()
689
 
        self.copy_content_into(result, revision_id=revision_id)
690
 
        result.set_parent(self.bzrdir.root_transport.base)
 
1159
        result.lock_write()
 
1160
        try:
 
1161
            if repository_policy is not None:
 
1162
                repository_policy.configure_branch(result)
 
1163
            self.copy_content_into(result, revision_id=revision_id)
 
1164
            result.set_parent(self.bzrdir.root_transport.base)
 
1165
        finally:
 
1166
            result.unlock()
691
1167
        return result
692
1168
 
693
1169
    def _synchronize_history(self, destination, revision_id):
694
1170
        """Synchronize last revision and revision history between branches.
695
1171
 
696
1172
        This version is most efficient when the destination is also a
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.
 
1173
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
1174
        repository contains all the lefthand ancestors of the intended
 
1175
        last_revision.  If not, set_last_revision_info will fail.
701
1176
 
702
1177
        :param destination: The branch to copy the history into
703
1178
        :param revision_id: The revision-id to truncate history at.  May
704
1179
          be None to copy complete history.
705
1180
        """
706
 
        if revision_id == _mod_revision.NULL_REVISION:
707
 
            new_history = []
 
1181
        source_revno, source_revision_id = self.last_revision_info()
 
1182
        if revision_id is None:
 
1183
            revno, revision_id = source_revno, source_revision_id
708
1184
        else:
709
 
            new_history = self.revision_history()
710
 
        if revision_id is not None and new_history != []:
 
1185
            graph = self.repository.get_graph()
711
1186
            try:
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)
 
1187
                revno = graph.find_distance_to_null(revision_id, 
 
1188
                    [(source_revision_id, source_revno)])
 
1189
            except errors.GhostRevisionsHaveNoRevno:
 
1190
                # Default to 1, if we can't find anything else
 
1191
                revno = 1
 
1192
        destination.set_last_revision_info(revno, revision_id)
717
1193
 
718
1194
    @needs_read_lock
719
1195
    def copy_content_into(self, destination, revision_id=None):
722
1198
        revision_id: if not None, the revision history in the new branch will
723
1199
                     be truncated to end with revision_id.
724
1200
        """
 
1201
        self.update_references(destination)
725
1202
        self._synchronize_history(destination, revision_id)
726
1203
        try:
727
1204
            parent = self.get_parent()
730
1207
        else:
731
1208
            if parent:
732
1209
                destination.set_parent(parent)
733
 
        self.tags.merge_to(destination.tags)
 
1210
        if self._push_should_merge_tags():
 
1211
            self.tags.merge_to(destination.tags)
 
1212
 
 
1213
    def update_references(self, target):
 
1214
        if not getattr(self._format, 'supports_reference_locations', False):
 
1215
            return
 
1216
        reference_dict = self._get_all_reference_info()
 
1217
        if len(reference_dict) == 0:
 
1218
            return
 
1219
        old_base = self.base
 
1220
        new_base = target.base
 
1221
        target_reference_dict = target._get_all_reference_info()
 
1222
        for file_id, (tree_path, branch_location) in (
 
1223
            reference_dict.items()):
 
1224
            branch_location = urlutils.rebase_url(branch_location,
 
1225
                                                  old_base, new_base)
 
1226
            target_reference_dict.setdefault(
 
1227
                file_id, (tree_path, branch_location))
 
1228
        target._set_all_reference_info(target_reference_dict)
734
1229
 
735
1230
    @needs_read_lock
736
 
    def check(self):
 
1231
    def check(self, refs):
737
1232
        """Check consistency of the branch.
738
1233
 
739
1234
        In particular this checks that revisions given in the revision-history
740
 
        do actually match up in the revision graph, and that they're all 
 
1235
        do actually match up in the revision graph, and that they're all
741
1236
        present in the repository.
742
 
        
 
1237
 
743
1238
        Callers will typically also want to check the repository.
744
1239
 
 
1240
        :param refs: Calculated refs for this branch as specified by
 
1241
            branch._get_check_refs()
745
1242
        :return: A BranchCheckResult.
746
1243
        """
747
 
        mainline_parent_id = None
 
1244
        result = BranchCheckResult(self)
748
1245
        last_revno, last_revision_id = self.last_revision_info()
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)
 
1246
        actual_revno = refs[('lefthand-distance', last_revision_id)]
 
1247
        if actual_revno != last_revno:
 
1248
            result.errors.append(errors.BzrCheckError(
 
1249
                'revno does not match len(mainline) %s != %s' % (
 
1250
                last_revno, actual_revno)))
 
1251
        # TODO: We should probably also check that self.revision_history
 
1252
        # matches the repository for older branch formats.
 
1253
        # If looking for the code that cross-checks repository parents against
 
1254
        # the iter_reverse_revision_history output, that is now a repository
 
1255
        # specific check.
 
1256
        return result
773
1257
 
774
1258
    def _get_checkout_format(self):
775
1259
        """Return the most suitable metadir for a checkout of this branch.
784
1268
            format.set_branch_format(self._format)
785
1269
        return format
786
1270
 
 
1271
    def create_clone_on_transport(self, to_transport, revision_id=None,
 
1272
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1273
        """Create a clone of this branch and its bzrdir.
 
1274
 
 
1275
        :param to_transport: The transport to clone onto.
 
1276
        :param revision_id: The revision id to use as tip in the new branch.
 
1277
            If None the tip is obtained from this branch.
 
1278
        :param stacked_on: An optional URL to stack the clone on.
 
1279
        :param create_prefix: Create any missing directories leading up to
 
1280
            to_transport.
 
1281
        :param use_existing_dir: Use an existing directory if one exists.
 
1282
        """
 
1283
        # XXX: Fix the bzrdir API to allow getting the branch back from the
 
1284
        # clone call. Or something. 20090224 RBC/spiv.
 
1285
        if revision_id is None:
 
1286
            revision_id = self.last_revision()
 
1287
        try:
 
1288
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1289
                revision_id=revision_id, stacked_on=stacked_on,
 
1290
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1291
        except errors.FileExists:
 
1292
            if not use_existing_dir:
 
1293
                raise
 
1294
        except errors.NoSuchFile:
 
1295
            if not create_prefix:
 
1296
                raise
 
1297
        return dir_to.open_branch()
 
1298
 
787
1299
    def create_checkout(self, to_location, revision_id=None,
788
1300
                        lightweight=False, accelerator_tree=None,
789
1301
                        hardlink=False):
790
1302
        """Create a checkout of a branch.
791
 
        
 
1303
 
792
1304
        :param to_location: The url to produce the checkout at
793
1305
        :param revision_id: The revision to check out
794
1306
        :param lightweight: If True, produce a lightweight checkout, otherwise,
813
1325
                to_location, force_new_tree=False, format=format)
814
1326
            checkout = checkout_branch.bzrdir
815
1327
            checkout_branch.bind(self)
816
 
            # pull up to the specified revision_id to set the initial 
 
1328
            # pull up to the specified revision_id to set the initial
817
1329
            # branch tip correctly, and seed it with history.
818
1330
            checkout_branch.pull(self, stop_revision=revision_id)
819
1331
            from_branch=None
841
1353
        reconciler.reconcile()
842
1354
        return reconciler
843
1355
 
844
 
    def reference_parent(self, file_id, path):
 
1356
    def reference_parent(self, file_id, path, possible_transports=None):
845
1357
        """Return the parent branch for a tree-reference file_id
846
1358
        :param file_id: The file_id of the tree reference
847
1359
        :param path: The path of the file_id in the tree
848
1360
        :return: A branch associated with the file_id
849
1361
        """
850
1362
        # FIXME should provide multiple branches, based on config
851
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
 
1363
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
 
1364
                           possible_transports=possible_transports)
852
1365
 
853
1366
    def supports_tags(self):
854
1367
        return self._format.supports_tags()
858
1371
        """Ensure that revision_b is a descendant of revision_a.
859
1372
 
860
1373
        This is a helper function for update_revisions.
861
 
        
 
1374
 
862
1375
        :raises: DivergedBranches if revision_b has diverged from revision_a.
863
1376
        :returns: True if revision_b is a descendant of revision_a.
864
1377
        """
874
1387
 
875
1388
    def _revision_relations(self, revision_a, revision_b, graph):
876
1389
        """Determine the relationship between two revisions.
877
 
        
 
1390
 
878
1391
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
879
1392
        """
880
1393
        heads = graph.heads([revision_a, revision_b])
897
1410
     * a format string,
898
1411
     * an open routine.
899
1412
 
900
 
    Formats are placed in an dict by their format string for reference 
 
1413
    Formats are placed in an dict by their format string for reference
901
1414
    during branch opening. Its not required that these be instances, they
902
 
    can be classes themselves with class methods - it simply depends on 
 
1415
    can be classes themselves with class methods - it simply depends on
903
1416
    whether state is needed for a given format or not.
904
1417
 
905
1418
    Once a format is deprecated, just deprecate the initialize and open
906
 
    methods on the format class. Do not deprecate the object, as the 
 
1419
    methods on the format class. Do not deprecate the object, as the
907
1420
    object will be created every time regardless.
908
1421
    """
909
1422
 
913
1426
    _formats = {}
914
1427
    """The known formats."""
915
1428
 
 
1429
    can_set_append_revisions_only = True
 
1430
 
916
1431
    def __eq__(self, other):
917
1432
        return self.__class__ is other.__class__
918
1433
 
991
1506
        control_files = lockable_files.LockableFiles(branch_transport,
992
1507
            lock_name, lock_class)
993
1508
        control_files.create_lock()
994
 
        control_files.lock_write()
 
1509
        try:
 
1510
            control_files.lock_write()
 
1511
        except errors.LockContention:
 
1512
            if lock_type != 'branch4':
 
1513
                raise
 
1514
            lock_taken = False
 
1515
        else:
 
1516
            lock_taken = True
995
1517
        if set_format:
996
1518
            utf8_files += [('format', self.get_format_string())]
997
1519
        try:
1000
1522
                    filename, content,
1001
1523
                    mode=a_bzrdir._get_file_mode())
1002
1524
        finally:
1003
 
            control_files.unlock()
 
1525
            if lock_taken:
 
1526
                control_files.unlock()
1004
1527
        return self.open(a_bzrdir, _found=True)
1005
1528
 
1006
1529
    def initialize(self, a_bzrdir):
1011
1534
        """Is this format supported?
1012
1535
 
1013
1536
        Supported formats can be initialized and opened.
1014
 
        Unsupported formats may not support initialization or committing or 
 
1537
        Unsupported formats may not support initialization or committing or
1015
1538
        some other features depending on the reason for not being supported.
1016
1539
        """
1017
1540
        return True
1018
1541
 
1019
 
    def open(self, a_bzrdir, _found=False):
 
1542
    def make_tags(self, branch):
 
1543
        """Create a tags object for branch.
 
1544
 
 
1545
        This method is on BranchFormat, because BranchFormats are reflected
 
1546
        over the wire via network_name(), whereas full Branch instances require
 
1547
        multiple VFS method calls to operate at all.
 
1548
 
 
1549
        The default implementation returns a disabled-tags instance.
 
1550
 
 
1551
        Note that it is normal for branch to be a RemoteBranch when using tags
 
1552
        on a RemoteBranch.
 
1553
        """
 
1554
        return DisabledTags(branch)
 
1555
 
 
1556
    def network_name(self):
 
1557
        """A simple byte string uniquely identifying this format for RPC calls.
 
1558
 
 
1559
        MetaDir branch formats use their disk format string to identify the
 
1560
        repository over the wire. All in one formats such as bzr < 0.8, and
 
1561
        foreign formats like svn/git and hg should use some marker which is
 
1562
        unique and immutable.
 
1563
        """
 
1564
        raise NotImplementedError(self.network_name)
 
1565
 
 
1566
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1020
1567
        """Return the branch object for a_bzrdir
1021
1568
 
1022
 
        _found is a private parameter, do not use it. It is used to indicate
1023
 
               if format probing has already be done.
 
1569
        :param a_bzrdir: A BzrDir that contains a branch.
 
1570
        :param _found: a private parameter, do not use it. It is used to
 
1571
            indicate if format probing has already be done.
 
1572
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
1573
            (if there are any).  Default is to open fallbacks.
1024
1574
        """
1025
1575
        raise NotImplementedError(self.open)
1026
1576
 
1027
1577
    @classmethod
1028
1578
    def register_format(klass, format):
 
1579
        """Register a metadir format."""
1029
1580
        klass._formats[format.get_format_string()] = format
 
1581
        # Metadir formats have a network name of their format string, and get
 
1582
        # registered as class factories.
 
1583
        network_format_registry.register(format.get_format_string(), format.__class__)
1030
1584
 
1031
1585
    @classmethod
1032
1586
    def set_default_format(klass, format):
1033
1587
        klass._default_format = format
1034
1588
 
 
1589
    def supports_set_append_revisions_only(self):
 
1590
        """True if this format supports set_append_revisions_only."""
 
1591
        return False
 
1592
 
1035
1593
    def supports_stacking(self):
1036
1594
        """True if this format records a stacked-on branch."""
1037
1595
        return False
1041
1599
        del klass._formats[format.get_format_string()]
1042
1600
 
1043
1601
    def __str__(self):
1044
 
        return self.get_format_string().rstrip()
 
1602
        return self.get_format_description().rstrip()
1045
1603
 
1046
1604
    def supports_tags(self):
1047
1605
        """True if this format supports tags stored in the branch"""
1050
1608
 
1051
1609
class BranchHooks(Hooks):
1052
1610
    """A dictionary mapping hook name to a list of callables for branch hooks.
1053
 
    
 
1611
 
1054
1612
    e.g. ['set_rh'] Is the list of items to be called when the
1055
1613
    set_revision_history function is invoked.
1056
1614
    """
1062
1620
        notified.
1063
1621
        """
1064
1622
        Hooks.__init__(self)
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'] = []
 
1623
        self.create_hook(HookPoint('set_rh',
 
1624
            "Invoked whenever the revision history has been set via "
 
1625
            "set_revision_history. The api signature is (branch, "
 
1626
            "revision_history), and the branch will be write-locked. "
 
1627
            "The set_rh hook can be expensive for bzr to trigger, a better "
 
1628
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1629
        self.create_hook(HookPoint('open',
 
1630
            "Called with the Branch object that has been opened after a "
 
1631
            "branch is opened.", (1, 8), None))
 
1632
        self.create_hook(HookPoint('post_push',
 
1633
            "Called after a push operation completes. post_push is called "
 
1634
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
 
1635
            "bzr client.", (0, 15), None))
 
1636
        self.create_hook(HookPoint('post_pull',
 
1637
            "Called after a pull operation completes. post_pull is called "
 
1638
            "with a bzrlib.branch.PullResult object and only runs in the "
 
1639
            "bzr client.", (0, 15), None))
 
1640
        self.create_hook(HookPoint('pre_commit',
 
1641
            "Called after a commit is calculated but before it is is "
 
1642
            "completed. pre_commit is called with (local, master, old_revno, "
 
1643
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
 
1644
            "). old_revid is NULL_REVISION for the first commit to a branch, "
 
1645
            "tree_delta is a TreeDelta object describing changes from the "
 
1646
            "basis revision. hooks MUST NOT modify this delta. "
 
1647
            " future_tree is an in-memory tree obtained from "
 
1648
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
 
1649
            "tree.", (0,91), None))
 
1650
        self.create_hook(HookPoint('post_commit',
 
1651
            "Called in the bzr client after a commit has completed. "
 
1652
            "post_commit is called with (local, master, old_revno, old_revid, "
 
1653
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
 
1654
            "commit to a branch.", (0, 15), None))
 
1655
        self.create_hook(HookPoint('post_uncommit',
 
1656
            "Called in the bzr client after an uncommit completes. "
 
1657
            "post_uncommit is called with (local, master, old_revno, "
 
1658
            "old_revid, new_revno, new_revid) where local is the local branch "
 
1659
            "or None, master is the target branch, and an empty branch "
 
1660
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1661
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1662
            "Called in bzr client and server before a change to the tip of a "
 
1663
            "branch is made. pre_change_branch_tip is called with a "
 
1664
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1665
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1666
        self.create_hook(HookPoint('post_change_branch_tip',
 
1667
            "Called in bzr client and server after a change to the tip of a "
 
1668
            "branch is made. post_change_branch_tip is called with a "
 
1669
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1670
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1671
        self.create_hook(HookPoint('transform_fallback_location',
 
1672
            "Called when a stacked branch is activating its fallback "
 
1673
            "locations. transform_fallback_location is called with (branch, "
 
1674
            "url), and should return a new url. Returning the same url "
 
1675
            "allows it to be used as-is, returning a different one can be "
 
1676
            "used to cause the branch to stack on a closer copy of that "
 
1677
            "fallback_location. Note that the branch cannot have history "
 
1678
            "accessing methods called on it during this hook because the "
 
1679
            "fallback locations have not been activated. When there are "
 
1680
            "multiple hooks installed for transform_fallback_location, "
 
1681
            "all are called with the url returned from the previous hook."
 
1682
            "The order is however undefined.", (1, 9), None))
1124
1683
 
1125
1684
 
1126
1685
# install the default hooks into the Branch class.
1158
1717
 
1159
1718
    def __eq__(self, other):
1160
1719
        return self.__dict__ == other.__dict__
1161
 
    
 
1720
 
1162
1721
    def __repr__(self):
1163
1722
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1164
 
            self.__class__.__name__, self.branch, 
 
1723
            self.__class__.__name__, self.branch,
1165
1724
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1166
1725
 
1167
1726
 
1189
1748
        super(BzrBranchFormat4, self).__init__()
1190
1749
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1191
1750
 
1192
 
    def open(self, a_bzrdir, _found=False):
1193
 
        """Return the branch object for a_bzrdir
 
1751
    def network_name(self):
 
1752
        """The network name for this format is the control dirs disk label."""
 
1753
        return self._matchingbzrdir.get_format_string()
1194
1754
 
1195
 
        _found is a private parameter, do not use it. It is used to indicate
1196
 
               if format probing has already be done.
1197
 
        """
 
1755
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1756
        """See BranchFormat.open()."""
1198
1757
        if not _found:
1199
1758
            # we are being called directly and must probe.
1200
1759
            raise NotImplementedError
1214
1773
        """What class to instantiate on open calls."""
1215
1774
        raise NotImplementedError(self._branch_class)
1216
1775
 
1217
 
    def open(self, a_bzrdir, _found=False):
1218
 
        """Return the branch object for a_bzrdir.
 
1776
    def network_name(self):
 
1777
        """A simple byte string uniquely identifying this format for RPC calls.
1219
1778
 
1220
 
        _found is a private parameter, do not use it. It is used to indicate
1221
 
               if format probing has already be done.
 
1779
        Metadir branch formats use their format string.
1222
1780
        """
 
1781
        return self.get_format_string()
 
1782
 
 
1783
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1784
        """See BranchFormat.open()."""
1223
1785
        if not _found:
1224
1786
            format = BranchFormat.find_format(a_bzrdir)
1225
1787
            if format.__class__ != self.__class__:
1232
1794
            return self._branch_class()(_format=self,
1233
1795
                              _control_files=control_files,
1234
1796
                              a_bzrdir=a_bzrdir,
1235
 
                              _repository=a_bzrdir.find_repository())
 
1797
                              _repository=a_bzrdir.find_repository(),
 
1798
                              ignore_fallbacks=ignore_fallbacks)
1236
1799
        except errors.NoSuchFile:
1237
1800
            raise errors.NotBranchError(path=transport.base)
1238
1801
 
1239
1802
    def __init__(self):
1240
1803
        super(BranchFormatMetadir, self).__init__()
1241
1804
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1805
        self._matchingbzrdir.set_branch_format(self)
1242
1806
 
1243
1807
    def supports_tags(self):
1244
1808
        return True
1267
1831
    def get_format_description(self):
1268
1832
        """See BranchFormat.get_format_description()."""
1269
1833
        return "Branch format 5"
1270
 
        
 
1834
 
1271
1835
    def initialize(self, a_bzrdir):
1272
1836
        """Create a branch of this format in a_bzrdir."""
1273
1837
        utf8_files = [('revision-history', ''),
1309
1873
                      ]
1310
1874
        return self._initialize_helper(a_bzrdir, utf8_files)
1311
1875
 
1312
 
 
1313
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1876
    def make_tags(self, branch):
 
1877
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1878
        return BasicTags(branch)
 
1879
 
 
1880
    def supports_set_append_revisions_only(self):
 
1881
        return True
 
1882
 
 
1883
 
 
1884
class BzrBranchFormat8(BranchFormatMetadir):
 
1885
    """Metadir format supporting storing locations of subtree branches."""
 
1886
 
 
1887
    def _branch_class(self):
 
1888
        return BzrBranch8
 
1889
 
 
1890
    def get_format_string(self):
 
1891
        """See BranchFormat.get_format_string()."""
 
1892
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
 
1893
 
 
1894
    def get_format_description(self):
 
1895
        """See BranchFormat.get_format_description()."""
 
1896
        return "Branch format 8"
 
1897
 
 
1898
    def initialize(self, a_bzrdir):
 
1899
        """Create a branch of this format in a_bzrdir."""
 
1900
        utf8_files = [('last-revision', '0 null:\n'),
 
1901
                      ('branch.conf', ''),
 
1902
                      ('tags', ''),
 
1903
                      ('references', '')
 
1904
                      ]
 
1905
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1906
 
 
1907
    def __init__(self):
 
1908
        super(BzrBranchFormat8, self).__init__()
 
1909
        self._matchingbzrdir.repository_format = \
 
1910
            RepositoryFormatKnitPack5RichRoot()
 
1911
 
 
1912
    def make_tags(self, branch):
 
1913
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1914
        return BasicTags(branch)
 
1915
 
 
1916
    def supports_set_append_revisions_only(self):
 
1917
        return True
 
1918
 
 
1919
    def supports_stacking(self):
 
1920
        return True
 
1921
 
 
1922
    supports_reference_locations = True
 
1923
 
 
1924
 
 
1925
class BzrBranchFormat7(BzrBranchFormat8):
1314
1926
    """Branch format with last-revision, tags, and a stacked location pointer.
1315
1927
 
1316
1928
    The stacked location pointer is passed down to the repository and requires
1319
1931
    This format was introduced in bzr 1.6.
1320
1932
    """
1321
1933
 
 
1934
    def initialize(self, a_bzrdir):
 
1935
        """Create a branch of this format in a_bzrdir."""
 
1936
        utf8_files = [('last-revision', '0 null:\n'),
 
1937
                      ('branch.conf', ''),
 
1938
                      ('tags', ''),
 
1939
                      ]
 
1940
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1941
 
1322
1942
    def _branch_class(self):
1323
1943
        return BzrBranch7
1324
1944
 
1330
1950
        """See BranchFormat.get_format_description()."""
1331
1951
        return "Branch format 7"
1332
1952
 
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):
 
1953
    def supports_set_append_revisions_only(self):
1347
1954
        return True
1348
1955
 
 
1956
    supports_reference_locations = False
 
1957
 
1349
1958
 
1350
1959
class BranchReferenceFormat(BranchFormat):
1351
1960
    """Bzr branch reference format.
1394
2003
    def __init__(self):
1395
2004
        super(BranchReferenceFormat, self).__init__()
1396
2005
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
2006
        self._matchingbzrdir.set_branch_format(self)
1397
2007
 
1398
2008
    def _make_reference_clone_function(format, a_branch):
1399
2009
        """Create a clone() routine for a branch dynamically."""
1400
 
        def clone(to_bzrdir, revision_id=None):
 
2010
        def clone(to_bzrdir, revision_id=None,
 
2011
            repository_policy=None):
1401
2012
            """See Branch.clone()."""
1402
2013
            return format.initialize(to_bzrdir, a_branch)
1403
2014
            # cannot obey revision_id limits when cloning a reference ...
1406
2017
        return clone
1407
2018
 
1408
2019
    def open(self, a_bzrdir, _found=False, location=None,
1409
 
             possible_transports=None):
 
2020
             possible_transports=None, ignore_fallbacks=False):
1410
2021
        """Return the branch that the branch reference in a_bzrdir points at.
1411
2022
 
1412
 
        _found is a private parameter, do not use it. It is used to indicate
1413
 
               if format probing has already be done.
 
2023
        :param a_bzrdir: A BzrDir that contains a branch.
 
2024
        :param _found: a private parameter, do not use it. It is used to
 
2025
            indicate if format probing has already be done.
 
2026
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
2027
            (if there are any).  Default is to open fallbacks.
 
2028
        :param location: The location of the referenced branch.  If
 
2029
            unspecified, this will be determined from the branch reference in
 
2030
            a_bzrdir.
 
2031
        :param possible_transports: An optional reusable transports list.
1414
2032
        """
1415
2033
        if not _found:
1416
2034
            format = BranchFormat.find_format(a_bzrdir)
1421
2039
            location = self.get_reference(a_bzrdir)
1422
2040
        real_bzrdir = bzrdir.BzrDir.open(
1423
2041
            location, possible_transports=possible_transports)
1424
 
        result = real_bzrdir.open_branch()
 
2042
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1425
2043
        # this changes the behaviour of result.clone to create a new reference
1426
2044
        # rather than a copy of the content of the branch.
1427
2045
        # I did not use a proxy object because that needs much more extensive
1434
2052
        return result
1435
2053
 
1436
2054
 
 
2055
network_format_registry = registry.FormatRegistry()
 
2056
"""Registry of formats indexed by their network name.
 
2057
 
 
2058
The network name for a branch format is an identifier that can be used when
 
2059
referring to formats with smart server operations. See
 
2060
BranchFormat.network_name() for more detail.
 
2061
"""
 
2062
 
 
2063
 
1437
2064
# formats which have no format string are not discoverable
1438
2065
# and not independently creatable, so are not registered.
1439
2066
__format5 = BzrBranchFormat5()
1440
2067
__format6 = BzrBranchFormat6()
1441
2068
__format7 = BzrBranchFormat7()
 
2069
__format8 = BzrBranchFormat8()
1442
2070
BranchFormat.register_format(__format5)
1443
2071
BranchFormat.register_format(BranchReferenceFormat())
1444
2072
BranchFormat.register_format(__format6)
1445
2073
BranchFormat.register_format(__format7)
1446
 
BranchFormat.set_default_format(__format6)
 
2074
BranchFormat.register_format(__format8)
 
2075
BranchFormat.set_default_format(__format7)
1447
2076
_legacy_formats = [BzrBranchFormat4(),
1448
 
                   ]
 
2077
    ]
 
2078
network_format_registry.register(
 
2079
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2080
 
1449
2081
 
1450
2082
class BzrBranch(Branch):
1451
2083
    """A branch stored in the actual filesystem.
1454
2086
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1455
2087
    it's writable, and can be accessed via the normal filesystem API.
1456
2088
 
1457
 
    :ivar _transport: Transport for file operations on this branch's 
 
2089
    :ivar _transport: Transport for file operations on this branch's
1458
2090
        control files, typically pointing to the .bzr/branch directory.
1459
2091
    :ivar repository: Repository for this branch.
1460
 
    :ivar base: The url of the base directory for this branch; the one 
 
2092
    :ivar base: The url of the base directory for this branch; the one
1461
2093
        containing the .bzr directory.
1462
2094
    """
1463
 
    
 
2095
 
1464
2096
    def __init__(self, _format=None,
1465
 
                 _control_files=None, a_bzrdir=None, _repository=None):
 
2097
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2098
                 ignore_fallbacks=False):
1466
2099
        """Create new branch object at a particular location."""
1467
2100
        if a_bzrdir is None:
1468
2101
            raise ValueError('a_bzrdir must be supplied')
1491
2124
 
1492
2125
    base = property(_get_base, doc="The URL for the root of this branch.")
1493
2126
 
 
2127
    def _get_config(self):
 
2128
        return TransportConfig(self._transport, 'branch.conf')
 
2129
 
1494
2130
    def is_locked(self):
1495
2131
        return self.control_files.is_locked()
1496
2132
 
1497
2133
    def lock_write(self, token=None):
1498
 
        repo_token = self.repository.lock_write()
 
2134
        # All-in-one needs to always unlock/lock.
 
2135
        repo_control = getattr(self.repository, 'control_files', None)
 
2136
        if self.control_files == repo_control or not self.is_locked():
 
2137
            self.repository.lock_write()
 
2138
            took_lock = True
 
2139
        else:
 
2140
            took_lock = False
1499
2141
        try:
1500
 
            token = self.control_files.lock_write(token=token)
 
2142
            return self.control_files.lock_write(token=token)
1501
2143
        except:
1502
 
            self.repository.unlock()
 
2144
            if took_lock:
 
2145
                self.repository.unlock()
1503
2146
            raise
1504
 
        return token
1505
2147
 
1506
2148
    def lock_read(self):
1507
 
        self.repository.lock_read()
 
2149
        # All-in-one needs to always unlock/lock.
 
2150
        repo_control = getattr(self.repository, 'control_files', None)
 
2151
        if self.control_files == repo_control or not self.is_locked():
 
2152
            self.repository.lock_read()
 
2153
            took_lock = True
 
2154
        else:
 
2155
            took_lock = False
1508
2156
        try:
1509
2157
            self.control_files.lock_read()
1510
2158
        except:
1511
 
            self.repository.unlock()
 
2159
            if took_lock:
 
2160
                self.repository.unlock()
1512
2161
            raise
1513
2162
 
1514
2163
    def unlock(self):
1515
 
        # TODO: test for failed two phase locks. This is known broken.
1516
2164
        try:
1517
2165
            self.control_files.unlock()
1518
2166
        finally:
1519
 
            self.repository.unlock()
1520
 
        if not self.control_files.is_locked():
1521
 
            # we just released the lock
1522
 
            self._clear_cached_state()
1523
 
        
 
2167
            # All-in-one needs to always unlock/lock.
 
2168
            repo_control = getattr(self.repository, 'control_files', None)
 
2169
            if (self.control_files == repo_control or
 
2170
                not self.control_files.is_locked()):
 
2171
                self.repository.unlock()
 
2172
            if not self.control_files.is_locked():
 
2173
                # we just released the lock
 
2174
                self._clear_cached_state()
 
2175
 
1524
2176
    def peek_lock_mode(self):
1525
2177
        if self.control_files._lock_count == 0:
1526
2178
            return None
1569
2221
        if Branch.hooks['post_change_branch_tip']:
1570
2222
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1571
2223
 
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:
 
2224
    def _synchronize_history(self, destination, revision_id):
 
2225
        """Synchronize last revision and revision history between branches.
 
2226
 
 
2227
        This version is most efficient when the destination is also a
 
2228
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2229
        history is the true lefthand parent history, and all of the revisions
 
2230
        are in the destination's repository.  If not, set_revision_history
 
2231
        will fail.
 
2232
 
 
2233
        :param destination: The branch to copy the history into
 
2234
        :param revision_id: The revision-id to truncate history at.  May
 
2235
          be None to copy complete history.
 
2236
        """
 
2237
        if not isinstance(destination._format, BzrBranchFormat5):
 
2238
            super(BzrBranch, self)._synchronize_history(
 
2239
                destination, revision_id)
1576
2240
            return
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:
 
2241
        if revision_id == _mod_revision.NULL_REVISION:
 
2242
            new_history = []
 
2243
        else:
 
2244
            new_history = self.revision_history()
 
2245
        if revision_id is not None and new_history != []:
1581
2246
            try:
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
 
 
 
2247
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2248
            except ValueError:
 
2249
                rev = self.repository.get_revision(revision_id)
 
2250
                new_history = rev.get_history(self.repository)[1:]
 
2251
        destination.set_revision_history(new_history)
 
2252
 
1602
2253
    @needs_write_lock
1603
2254
    def set_last_revision_info(self, revno, revision_id):
1604
2255
        """Set the last revision of this branch.
1607
2258
        for this revision id.
1608
2259
 
1609
2260
        It may be possible to set the branch last revision to an id not
1610
 
        present in the repository.  However, branches can also be 
 
2261
        present in the repository.  However, branches can also be
1611
2262
        configured to check constraints on history, in which case this may not
1612
2263
        be permitted.
1613
2264
        """
1627
2278
            history.pop()
1628
2279
        return history
1629
2280
 
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
 
 
1657
2281
    @needs_write_lock
1658
2282
    def generate_revision_history(self, revision_id, last_rev=None,
1659
2283
        other_branch=None):
1672
2296
        """See Branch.basis_tree."""
1673
2297
        return self.repository.revision_tree(self.last_revision())
1674
2298
 
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
 
 
1718
2299
    def _get_parent_location(self):
1719
2300
        _locs = ['parent', 'pull', 'x-pull']
1720
2301
        for l in _locs:
1724
2305
                pass
1725
2306
        return None
1726
2307
 
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
 
 
1796
2308
    def _basic_push(self, target, overwrite, stop_revision):
1797
2309
        """Basic implementation of push without bound branches or hooks.
1798
2310
 
1799
 
        Must be called with self read locked and target write locked.
 
2311
        Must be called with source read locked and target write locked.
1800
2312
        """
1801
 
        result = PushResult()
 
2313
        result = BranchPushResult()
1802
2314
        result.source_branch = self
1803
2315
        result.target_branch = target
1804
2316
        result.old_revno, result.old_revid = target.last_revision_info()
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)
 
2317
        self.update_references(target)
 
2318
        if result.old_revid != self.last_revision():
 
2319
            # We assume that during 'push' this repository is closer than
 
2320
            # the target.
 
2321
            graph = self.repository.get_graph(target.repository)
 
2322
            target.update_revisions(self, stop_revision,
 
2323
                overwrite=overwrite, graph=graph)
 
2324
        if self._push_should_merge_tags():
 
2325
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2326
                overwrite)
1812
2327
        result.new_revno, result.new_revid = target.last_revision_info()
1813
2328
        return result
1814
2329
 
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
 
 
1829
2330
    def get_stacked_on_url(self):
1830
2331
        raise errors.UnstackableBranchFormat(self._format, self.base)
1831
2332
 
1835
2336
            'push_location', location,
1836
2337
            store=_mod_config.STORE_LOCATION_NORECURSE)
1837
2338
 
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
 
 
1856
2339
    def _set_parent_location(self, url):
1857
2340
        if url is None:
1858
2341
            self._transport.delete('parent')
1860
2343
            self._transport.put_bytes('parent', url + '\n',
1861
2344
                mode=self.bzrdir._get_file_mode())
1862
2345
 
1863
 
    def set_stacked_on_url(self, url):
1864
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
1865
 
 
1866
2346
 
1867
2347
class BzrBranch5(BzrBranch):
1868
2348
    """A format 5 branch. This supports new features over plain branches.
1870
2350
    It has support for a master_branch which is the data for bound branches.
1871
2351
    """
1872
2352
 
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
 
 
1902
2353
    def get_bound_location(self):
1903
2354
        try:
1904
2355
            return self._transport.get_bytes('bound')[:-1]
1908
2359
    @needs_read_lock
1909
2360
    def get_master_branch(self, possible_transports=None):
1910
2361
        """Return the branch we are bound to.
1911
 
        
 
2362
 
1912
2363
        :return: Either a Branch, or None
1913
2364
 
1914
2365
        This could memoise the branch, but if thats done
1950
2401
        check for divergence to raise an error when the branches are not
1951
2402
        either the same, or one a prefix of the other. That behaviour may not
1952
2403
        be useful, so that check may be removed in future.
1953
 
        
 
2404
 
1954
2405
        :param other: The branch to bind to
1955
2406
        :type other: Branch
1956
2407
        """
1975
2426
 
1976
2427
    @needs_write_lock
1977
2428
    def update(self, possible_transports=None):
1978
 
        """Synchronise this branch with the master branch if any. 
 
2429
        """Synchronise this branch with the master branch if any.
1979
2430
 
1980
2431
        :return: None or the last_revision that was pivoted out during the
1981
2432
                 update.
1991
2442
        return None
1992
2443
 
1993
2444
 
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))
 
2445
class BzrBranch8(BzrBranch5):
 
2446
    """A branch that stores tree-reference locations."""
2006
2447
 
2007
2448
    def _open_hook(self):
 
2449
        if self._ignore_fallbacks:
 
2450
            return
2008
2451
        try:
2009
2452
            url = self.get_stacked_on_url()
2010
2453
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2011
2454
            errors.UnstackableBranchFormat):
2012
2455
            pass
2013
2456
        else:
 
2457
            for hook in Branch.hooks['transform_fallback_location']:
 
2458
                url = hook(self, url)
 
2459
                if url is None:
 
2460
                    hook_name = Branch.hooks.get_hook_name(hook)
 
2461
                    raise AssertionError(
 
2462
                        "'transform_fallback_location' hook %s returned "
 
2463
                        "None, not a URL." % hook_name)
2014
2464
            self._activate_fallback_location(url)
2015
2465
 
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
 
 
2021
2466
    def __init__(self, *args, **kwargs):
2022
 
        super(BzrBranch7, self).__init__(*args, **kwargs)
 
2467
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
 
2468
        super(BzrBranch8, self).__init__(*args, **kwargs)
2023
2469
        self._last_revision_info_cache = None
2024
 
        self._partial_revision_history_cache = []
 
2470
        self._reference_info = None
2025
2471
 
2026
2472
    def _clear_cached_state(self):
2027
 
        super(BzrBranch7, self)._clear_cached_state()
 
2473
        super(BzrBranch8, self)._clear_cached_state()
2028
2474
        self._last_revision_info_cache = None
2029
 
        self._partial_revision_history_cache = []
 
2475
        self._reference_info = None
2030
2476
 
2031
2477
    def _last_revision_info(self):
2032
2478
        revision_string = self._transport.get_bytes('last-revision')
2061
2507
        self._last_revision_info_cache = revno, revision_id
2062
2508
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2063
2509
 
 
2510
    def _synchronize_history(self, destination, revision_id):
 
2511
        """Synchronize last revision and revision history between branches.
 
2512
 
 
2513
        :see: Branch._synchronize_history
 
2514
        """
 
2515
        # XXX: The base Branch has a fast implementation of this method based
 
2516
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2517
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2518
        # but wants the fast implementation, so it calls
 
2519
        # Branch._synchronize_history directly.
 
2520
        Branch._synchronize_history(self, destination, revision_id)
 
2521
 
2064
2522
    def _check_history_violation(self, revision_id):
2065
2523
        last_revision = _mod_revision.ensure_null(self.last_revision())
2066
2524
        if _mod_revision.is_null(last_revision):
2075
2533
        self._extend_partial_history(stop_index=last_revno-1)
2076
2534
        return list(reversed(self._partial_revision_history_cache))
2077
2535
 
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
 
 
2107
2536
    def _write_revision_history(self, history):
2108
2537
        """Factored out of set_revision_history.
2109
2538
 
2130
2559
        """Set the parent branch"""
2131
2560
        return self._get_config_location('parent_location')
2132
2561
 
 
2562
    @needs_write_lock
 
2563
    def _set_all_reference_info(self, info_dict):
 
2564
        """Replace all reference info stored in a branch.
 
2565
 
 
2566
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
 
2567
        """
 
2568
        s = StringIO()
 
2569
        writer = rio.RioWriter(s)
 
2570
        for key, (tree_path, branch_location) in info_dict.iteritems():
 
2571
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
 
2572
                                branch_location=branch_location)
 
2573
            writer.write_stanza(stanza)
 
2574
        self._transport.put_bytes('references', s.getvalue())
 
2575
        self._reference_info = info_dict
 
2576
 
 
2577
    @needs_read_lock
 
2578
    def _get_all_reference_info(self):
 
2579
        """Return all the reference info stored in a branch.
 
2580
 
 
2581
        :return: A dict of {file_id: (tree_path, branch_location)}
 
2582
        """
 
2583
        if self._reference_info is not None:
 
2584
            return self._reference_info
 
2585
        rio_file = self._transport.get('references')
 
2586
        try:
 
2587
            stanzas = rio.read_stanzas(rio_file)
 
2588
            info_dict = dict((s['file_id'], (s['tree_path'],
 
2589
                             s['branch_location'])) for s in stanzas)
 
2590
        finally:
 
2591
            rio_file.close()
 
2592
        self._reference_info = info_dict
 
2593
        return info_dict
 
2594
 
 
2595
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2596
        """Set the branch location to use for a tree reference.
 
2597
 
 
2598
        :param file_id: The file-id of the tree reference.
 
2599
        :param tree_path: The path of the tree reference in the tree.
 
2600
        :param branch_location: The location of the branch to retrieve tree
 
2601
            references from.
 
2602
        """
 
2603
        info_dict = self._get_all_reference_info()
 
2604
        info_dict[file_id] = (tree_path, branch_location)
 
2605
        if None in (tree_path, branch_location):
 
2606
            if tree_path is not None:
 
2607
                raise ValueError('tree_path must be None when branch_location'
 
2608
                                 ' is None.')
 
2609
            if branch_location is not None:
 
2610
                raise ValueError('branch_location must be None when tree_path'
 
2611
                                 ' is None.')
 
2612
            del info_dict[file_id]
 
2613
        self._set_all_reference_info(info_dict)
 
2614
 
 
2615
    def get_reference_info(self, file_id):
 
2616
        """Get the tree_path and branch_location for a tree reference.
 
2617
 
 
2618
        :return: a tuple of (tree_path, branch_location)
 
2619
        """
 
2620
        return self._get_all_reference_info().get(file_id, (None, None))
 
2621
 
 
2622
    def reference_parent(self, file_id, path, possible_transports=None):
 
2623
        """Return the parent branch for a tree-reference file_id.
 
2624
 
 
2625
        :param file_id: The file_id of the tree reference
 
2626
        :param path: The path of the file_id in the tree
 
2627
        :return: A branch associated with the file_id
 
2628
        """
 
2629
        branch_location = self.get_reference_info(file_id)[1]
 
2630
        if branch_location is None:
 
2631
            return Branch.reference_parent(self, file_id, path,
 
2632
                                           possible_transports)
 
2633
        branch_location = urlutils.join(self.base, branch_location)
 
2634
        return Branch.open(branch_location,
 
2635
                           possible_transports=possible_transports)
 
2636
 
2133
2637
    def set_push_location(self, location):
2134
2638
        """See Branch.set_push_location."""
2135
2639
        self._set_config_location('push_location', location)
2169
2673
        return self._get_bound_location(False)
2170
2674
 
2171
2675
    def get_stacked_on_url(self):
2172
 
        self._check_stackable_repo()
 
2676
        # you can always ask for the URL; but you might not be able to use it
 
2677
        # if the repo can't support stacking.
 
2678
        ## self._check_stackable_repo()
2173
2679
        stacked_url = self._get_config_location('stacked_on_location')
2174
2680
        if stacked_url is None:
2175
2681
            raise errors.NotStacked(self)
2176
2682
        return stacked_url
2177
2683
 
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
 
 
2212
2684
    def _get_append_revisions_only(self):
2213
2685
        value = self.get_config().get_user_option('append_revisions_only')
2214
2686
        return value == 'True'
2215
2687
 
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
 
 
2248
2688
    @needs_write_lock
2249
2689
    def generate_revision_history(self, revision_id, last_rev=None,
2250
2690
                                  other_branch=None):
2289
2729
        return self.revno() - index
2290
2730
 
2291
2731
 
 
2732
class BzrBranch7(BzrBranch8):
 
2733
    """A branch with support for a fallback repository."""
 
2734
 
 
2735
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2736
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
 
2737
 
 
2738
    def get_reference_info(self, file_id):
 
2739
        Branch.get_reference_info(self, file_id)
 
2740
 
 
2741
    def reference_parent(self, file_id, path, possible_transports=None):
 
2742
        return Branch.reference_parent(self, file_id, path,
 
2743
                                       possible_transports)
 
2744
 
 
2745
 
2292
2746
class BzrBranch6(BzrBranch7):
2293
2747
    """See BzrBranchFormat6 for the capabilities of this branch.
2294
2748
 
2299
2753
    def get_stacked_on_url(self):
2300
2754
        raise errors.UnstackableBranchFormat(self._format, self.base)
2301
2755
 
2302
 
    def set_stacked_on_url(self, url):
2303
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2304
 
 
2305
2756
 
2306
2757
######################################################################
2307
2758
# results of operations
2324
2775
    :ivar new_revno: Revision number after pull.
2325
2776
    :ivar old_revid: Tip revision id before pull.
2326
2777
    :ivar new_revid: Tip revision id after pull.
2327
 
    :ivar source_branch: Source (local) branch object.
 
2778
    :ivar source_branch: Source (local) branch object. (read locked)
2328
2779
    :ivar master_branch: Master branch of the target, or the target if no
2329
2780
        Master
2330
2781
    :ivar local_branch: target branch if there is a Master, else None
2331
 
    :ivar target_branch: Target/destination branch object.
 
2782
    :ivar target_branch: Target/destination branch object. (write locked)
2332
2783
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2333
2784
    """
2334
2785
 
2345
2796
        self._show_tag_conficts(to_file)
2346
2797
 
2347
2798
 
2348
 
class PushResult(_Result):
 
2799
class BranchPushResult(_Result):
2349
2800
    """Result of a Branch.push operation.
2350
2801
 
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.
 
2802
    :ivar old_revno: Revision number (eg 10) of the target before push.
 
2803
    :ivar new_revno: Revision number (eg 12) of the target after push.
 
2804
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
 
2805
        before the push.
 
2806
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
 
2807
        after the push.
 
2808
    :ivar source_branch: Source branch object that the push was from. This is
 
2809
        read locked, and generally is a local (and thus low latency) branch.
 
2810
    :ivar master_branch: If target is a bound branch, the master branch of
 
2811
        target, or target itself. Always write locked.
 
2812
    :ivar target_branch: The direct Branch where data is being sent (write
 
2813
        locked).
 
2814
    :ivar local_branch: If the target is a bound branch this will be the
 
2815
        target, otherwise it will be None.
2358
2816
    """
2359
2817
 
2360
2818
    def __int__(self):
2364
2822
    def report(self, to_file):
2365
2823
        """Write a human-readable description of the result."""
2366
2824
        if self.old_revid == self.new_revid:
2367
 
            to_file.write('No new revisions to push.\n')
 
2825
            note('No new revisions to push.')
2368
2826
        else:
2369
 
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
 
2827
            note('Pushed up to revision %d.' % self.new_revno)
2370
2828
        self._show_tag_conficts(to_file)
2371
2829
 
2372
2830
 
2378
2836
 
2379
2837
    def __init__(self, branch):
2380
2838
        self.branch = branch
 
2839
        self.errors = []
2381
2840
 
2382
2841
    def report_results(self, verbose):
2383
2842
        """Report the check results via trace.note.
2384
 
        
 
2843
 
2385
2844
        :param verbose: Requests more detailed display of what was checked,
2386
2845
            if any.
2387
2846
        """
2388
 
        note('checked branch %s format %s',
2389
 
             self.branch.base,
2390
 
             self.branch._format)
 
2847
        note('checked branch %s format %s', self.branch.base,
 
2848
            self.branch._format)
 
2849
        for error in self.errors:
 
2850
            note('found error:%s', error)
2391
2851
 
2392
2852
 
2393
2853
class Converter5to6(object):
2429
2889
        branch._set_config_location('stacked_on_location', '')
2430
2890
        # update target format
2431
2891
        branch._transport.put_bytes('format', format.get_format_string())
 
2892
 
 
2893
 
 
2894
class Converter7to8(object):
 
2895
    """Perform an in-place upgrade of format 6 to format 7"""
 
2896
 
 
2897
    def convert(self, branch):
 
2898
        format = BzrBranchFormat8()
 
2899
        branch._transport.put_bytes('references', '')
 
2900
        # update target format
 
2901
        branch._transport.put_bytes('format', format.get_format_string())
 
2902
 
 
2903
 
 
2904
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2905
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2906
    duration.
 
2907
 
 
2908
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2909
 
 
2910
    If an exception is raised by callable, then that exception *will* be
 
2911
    propagated, even if the unlock attempt raises its own error.  Thus
 
2912
    _run_with_write_locked_target should be preferred to simply doing::
 
2913
 
 
2914
        target.lock_write()
 
2915
        try:
 
2916
            return callable(*args, **kwargs)
 
2917
        finally:
 
2918
            target.unlock()
 
2919
 
 
2920
    """
 
2921
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2922
    # should share code?
 
2923
    target.lock_write()
 
2924
    try:
 
2925
        result = callable(*args, **kwargs)
 
2926
    except:
 
2927
        exc_info = sys.exc_info()
 
2928
        try:
 
2929
            target.unlock()
 
2930
        finally:
 
2931
            raise exc_info[0], exc_info[1], exc_info[2]
 
2932
    else:
 
2933
        target.unlock()
 
2934
        return result
 
2935
 
 
2936
 
 
2937
class InterBranch(InterObject):
 
2938
    """This class represents operations taking place between two branches.
 
2939
 
 
2940
    Its instances have methods like pull() and push() and contain
 
2941
    references to the source and target repositories these operations
 
2942
    can be carried out on.
 
2943
    """
 
2944
 
 
2945
    _optimisers = []
 
2946
    """The available optimised InterBranch types."""
 
2947
 
 
2948
    @staticmethod
 
2949
    def _get_branch_formats_to_test():
 
2950
        """Return a tuple with the Branch formats to use when testing."""
 
2951
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2952
 
 
2953
    def pull(self, overwrite=False, stop_revision=None,
 
2954
             possible_transports=None, local=False):
 
2955
        """Mirror source into target branch.
 
2956
 
 
2957
        The target branch is considered to be 'local', having low latency.
 
2958
 
 
2959
        :returns: PullResult instance
 
2960
        """
 
2961
        raise NotImplementedError(self.pull)
 
2962
 
 
2963
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2964
                         graph=None):
 
2965
        """Pull in new perfect-fit revisions.
 
2966
 
 
2967
        :param stop_revision: Updated until the given revision
 
2968
        :param overwrite: Always set the branch pointer, rather than checking
 
2969
            to see if it is a proper descendant.
 
2970
        :param graph: A Graph object that can be used to query history
 
2971
            information. This can be None.
 
2972
        :return: None
 
2973
        """
 
2974
        raise NotImplementedError(self.update_revisions)
 
2975
 
 
2976
    def push(self, overwrite=False, stop_revision=None,
 
2977
             _override_hook_source_branch=None):
 
2978
        """Mirror the source branch into the target branch.
 
2979
 
 
2980
        The source branch is considered to be 'local', having low latency.
 
2981
        """
 
2982
        raise NotImplementedError(self.push)
 
2983
 
 
2984
 
 
2985
class GenericInterBranch(InterBranch):
 
2986
    """InterBranch implementation that uses public Branch functions.
 
2987
    """
 
2988
 
 
2989
    @staticmethod
 
2990
    def _get_branch_formats_to_test():
 
2991
        return BranchFormat._default_format, BranchFormat._default_format
 
2992
 
 
2993
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2994
        graph=None):
 
2995
        """See InterBranch.update_revisions()."""
 
2996
        self.source.lock_read()
 
2997
        try:
 
2998
            other_revno, other_last_revision = self.source.last_revision_info()
 
2999
            stop_revno = None # unknown
 
3000
            if stop_revision is None:
 
3001
                stop_revision = other_last_revision
 
3002
                if _mod_revision.is_null(stop_revision):
 
3003
                    # if there are no commits, we're done.
 
3004
                    return
 
3005
                stop_revno = other_revno
 
3006
 
 
3007
            # what's the current last revision, before we fetch [and change it
 
3008
            # possibly]
 
3009
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3010
            # we fetch here so that we don't process data twice in the common
 
3011
            # case of having something to pull, and so that the check for
 
3012
            # already merged can operate on the just fetched graph, which will
 
3013
            # be cached in memory.
 
3014
            self.target.fetch(self.source, stop_revision)
 
3015
            # Check to see if one is an ancestor of the other
 
3016
            if not overwrite:
 
3017
                if graph is None:
 
3018
                    graph = self.target.repository.get_graph()
 
3019
                if self.target._check_if_descendant_or_diverged(
 
3020
                        stop_revision, last_rev, graph, self.source):
 
3021
                    # stop_revision is a descendant of last_rev, but we aren't
 
3022
                    # overwriting, so we're done.
 
3023
                    return
 
3024
            if stop_revno is None:
 
3025
                if graph is None:
 
3026
                    graph = self.target.repository.get_graph()
 
3027
                this_revno, this_last_revision = \
 
3028
                        self.target.last_revision_info()
 
3029
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3030
                                [(other_last_revision, other_revno),
 
3031
                                 (this_last_revision, this_revno)])
 
3032
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3033
        finally:
 
3034
            self.source.unlock()
 
3035
 
 
3036
    def pull(self, overwrite=False, stop_revision=None,
 
3037
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3038
             _override_hook_target=None, local=False):
 
3039
        """See Branch.pull.
 
3040
 
 
3041
        :param _hook_master: Private parameter - set the branch to
 
3042
            be supplied as the master to pull hooks.
 
3043
        :param run_hooks: Private parameter - if false, this branch
 
3044
            is being called because it's the master of the primary branch,
 
3045
            so it should not run its hooks.
 
3046
        :param _override_hook_target: Private parameter - set the branch to be
 
3047
            supplied as the target_branch to pull hooks.
 
3048
        :param local: Only update the local branch, and not the bound branch.
 
3049
        """
 
3050
        # This type of branch can't be bound.
 
3051
        if local:
 
3052
            raise errors.LocalRequiresBoundBranch()
 
3053
        result = PullResult()
 
3054
        result.source_branch = self.source
 
3055
        if _override_hook_target is None:
 
3056
            result.target_branch = self.target
 
3057
        else:
 
3058
            result.target_branch = _override_hook_target
 
3059
        self.source.lock_read()
 
3060
        try:
 
3061
            # We assume that during 'pull' the target repository is closer than
 
3062
            # the source one.
 
3063
            self.source.update_references(self.target)
 
3064
            graph = self.target.repository.get_graph(self.source.repository)
 
3065
            # TODO: Branch formats should have a flag that indicates 
 
3066
            # that revno's are expensive, and pull() should honor that flag.
 
3067
            # -- JRV20090506
 
3068
            result.old_revno, result.old_revid = \
 
3069
                self.target.last_revision_info()
 
3070
            self.target.update_revisions(self.source, stop_revision,
 
3071
                overwrite=overwrite, graph=graph)
 
3072
            # TODO: The old revid should be specified when merging tags, 
 
3073
            # so a tags implementation that versions tags can only 
 
3074
            # pull in the most recent changes. -- JRV20090506
 
3075
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3076
                overwrite)
 
3077
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3078
            if _hook_master:
 
3079
                result.master_branch = _hook_master
 
3080
                result.local_branch = result.target_branch
 
3081
            else:
 
3082
                result.master_branch = result.target_branch
 
3083
                result.local_branch = None
 
3084
            if run_hooks:
 
3085
                for hook in Branch.hooks['post_pull']:
 
3086
                    hook(result)
 
3087
        finally:
 
3088
            self.source.unlock()
 
3089
        return result
 
3090
 
 
3091
    def push(self, overwrite=False, stop_revision=None,
 
3092
             _override_hook_source_branch=None):
 
3093
        """See InterBranch.push.
 
3094
 
 
3095
        This is the basic concrete implementation of push()
 
3096
 
 
3097
        :param _override_hook_source_branch: If specified, run
 
3098
        the hooks passing this Branch as the source, rather than self.
 
3099
        This is for use of RemoteBranch, where push is delegated to the
 
3100
        underlying vfs-based Branch.
 
3101
        """
 
3102
        # TODO: Public option to disable running hooks - should be trivial but
 
3103
        # needs tests.
 
3104
        self.source.lock_read()
 
3105
        try:
 
3106
            return _run_with_write_locked_target(
 
3107
                self.target, self._push_with_bound_branches, overwrite,
 
3108
                stop_revision,
 
3109
                _override_hook_source_branch=_override_hook_source_branch)
 
3110
        finally:
 
3111
            self.source.unlock()
 
3112
 
 
3113
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3114
            _override_hook_source_branch=None):
 
3115
        """Push from source into target, and into target's master if any.
 
3116
        """
 
3117
        def _run_hooks():
 
3118
            if _override_hook_source_branch:
 
3119
                result.source_branch = _override_hook_source_branch
 
3120
            for hook in Branch.hooks['post_push']:
 
3121
                hook(result)
 
3122
 
 
3123
        bound_location = self.target.get_bound_location()
 
3124
        if bound_location and self.target.base != bound_location:
 
3125
            # there is a master branch.
 
3126
            #
 
3127
            # XXX: Why the second check?  Is it even supported for a branch to
 
3128
            # be bound to itself? -- mbp 20070507
 
3129
            master_branch = self.target.get_master_branch()
 
3130
            master_branch.lock_write()
 
3131
            try:
 
3132
                # push into the master from the source branch.
 
3133
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3134
                # and push into the target branch from the source. Note that we
 
3135
                # push from the source branch again, because its considered the
 
3136
                # highest bandwidth repository.
 
3137
                result = self.source._basic_push(self.target, overwrite,
 
3138
                    stop_revision)
 
3139
                result.master_branch = master_branch
 
3140
                result.local_branch = self.target
 
3141
                _run_hooks()
 
3142
                return result
 
3143
            finally:
 
3144
                master_branch.unlock()
 
3145
        else:
 
3146
            # no master branch
 
3147
            result = self.source._basic_push(self.target, overwrite,
 
3148
                stop_revision)
 
3149
            # TODO: Why set master_branch and local_branch if there's no
 
3150
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3151
            # 20070504
 
3152
            result.master_branch = self.target
 
3153
            result.local_branch = None
 
3154
            _run_hooks()
 
3155
            return result
 
3156
 
 
3157
    @classmethod
 
3158
    def is_compatible(self, source, target):
 
3159
        # GenericBranch uses the public API, so always compatible
 
3160
        return True
 
3161
 
 
3162
 
 
3163
class InterToBranch5(GenericInterBranch):
 
3164
 
 
3165
    @staticmethod
 
3166
    def _get_branch_formats_to_test():
 
3167
        return BranchFormat._default_format, BzrBranchFormat5()
 
3168
 
 
3169
    def pull(self, overwrite=False, stop_revision=None,
 
3170
             possible_transports=None, run_hooks=True,
 
3171
             _override_hook_target=None, local=False):
 
3172
        """Pull from source into self, updating my master if any.
 
3173
 
 
3174
        :param run_hooks: Private parameter - if false, this branch
 
3175
            is being called because it's the master of the primary branch,
 
3176
            so it should not run its hooks.
 
3177
        """
 
3178
        bound_location = self.target.get_bound_location()
 
3179
        if local and not bound_location:
 
3180
            raise errors.LocalRequiresBoundBranch()
 
3181
        master_branch = None
 
3182
        if not local and bound_location and self.source.base != bound_location:
 
3183
            # not pulling from master, so we need to update master.
 
3184
            master_branch = self.target.get_master_branch(possible_transports)
 
3185
            master_branch.lock_write()
 
3186
        try:
 
3187
            if master_branch:
 
3188
                # pull from source into master.
 
3189
                master_branch.pull(self.source, overwrite, stop_revision,
 
3190
                    run_hooks=False)
 
3191
            return super(InterToBranch5, self).pull(overwrite,
 
3192
                stop_revision, _hook_master=master_branch,
 
3193
                run_hooks=run_hooks,
 
3194
                _override_hook_target=_override_hook_target)
 
3195
        finally:
 
3196
            if master_branch:
 
3197
                master_branch.unlock()
 
3198
 
 
3199
 
 
3200
InterBranch.register_optimiser(GenericInterBranch)
 
3201
InterBranch.register_optimiser(InterToBranch5)