1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
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
 
 
20
from bzrlib.lazy_import import lazy_import
 
 
21
lazy_import(globals(), """
 
 
22
from itertools import chain
 
 
26
        config as _mod_config,
 
 
32
        revision as _mod_revision,
 
 
38
from bzrlib.config import BranchConfig
 
 
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
 
40
from bzrlib.tag import (
 
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
 
47
from bzrlib.hooks import Hooks
 
 
48
from bzrlib.symbol_versioning import (
 
 
52
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
 
 
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
 
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
 
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
 
60
# TODO: Maybe include checks for common corruption of newlines, etc?
 
 
62
# TODO: Some operations like log might retrieve the same revisions
 
 
63
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
 
64
# cache in memory to make this faster.  In general anything can be
 
 
65
# cached in memory between lock and unlock operations. .. nb thats
 
 
66
# what the transaction identity map provides
 
 
69
######################################################################
 
 
73
    """Branch holding a history of revisions.
 
 
76
        Base directory/url of the branch.
 
 
78
    hooks: An instance of BranchHooks.
 
 
80
    # this is really an instance variable - FIXME move it there
 
 
84
    # override this to set the strategy for storing tags
 
 
86
        return DisabledTags(self)
 
 
88
    def __init__(self, *ignored, **ignored_too):
 
 
89
        self.tags = self._make_tags()
 
 
90
        self._revision_history_cache = None
 
 
91
        self._revision_id_to_revno_cache = None
 
 
92
        self._last_revision_info_cache = None
 
 
94
        hooks = Branch.hooks['open']
 
 
99
        """Called by init to allow simpler extension of the base class."""
 
 
101
    def break_lock(self):
 
 
102
        """Break a lock if one is present from another instance.
 
 
104
        Uses the ui factory to ask for confirmation if the lock may be from
 
 
107
        This will probe the repository for its lock as well.
 
 
109
        self.control_files.break_lock()
 
 
110
        self.repository.break_lock()
 
 
111
        master = self.get_master_branch()
 
 
112
        if master is not None:
 
 
116
    def open(base, _unsupported=False, possible_transports=None):
 
 
117
        """Open the branch rooted at base.
 
 
119
        For instance, if the branch is at URL/.bzr/branch,
 
 
120
        Branch.open(URL) -> a Branch instance.
 
 
122
        control = bzrdir.BzrDir.open(base, _unsupported,
 
 
123
                                     possible_transports=possible_transports)
 
 
124
        return control.open_branch(_unsupported)
 
 
127
    def open_from_transport(transport, _unsupported=False):
 
 
128
        """Open the branch rooted at transport"""
 
 
129
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
 
 
130
        return control.open_branch(_unsupported)
 
 
133
    def open_containing(url, possible_transports=None):
 
 
134
        """Open an existing branch which contains url.
 
 
136
        This probes for a branch at url, and searches upwards from there.
 
 
138
        Basically we keep looking up until we find the control directory or
 
 
139
        run into the root.  If there isn't one, raises NotBranchError.
 
 
140
        If there is one and it is either an unrecognised format or an unsupported 
 
 
141
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
 
142
        If there is one, it is returned, along with the unused portion of url.
 
 
144
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
 
146
        return control.open_branch(), relpath
 
 
148
    def get_config(self):
 
 
149
        return BranchConfig(self)
 
 
151
    def _get_nick(self, possible_transports=None):
 
 
152
        config = self.get_config()
 
 
153
        if not config.has_explicit_nickname(): # explicit overrides master
 
 
155
                master = self.get_master_branch(possible_transports)
 
 
156
                if master is not None:
 
 
157
                    # return the master branch value
 
 
158
                    config = master.get_config()
 
 
159
            except errors.BzrError, e:
 
 
160
                # Silently fall back to local implicit nick if the master is
 
 
162
                mutter("Could not connect to bound branch, "
 
 
163
                    "falling back to local nick.\n " + str(e))
 
 
164
        return config.get_nickname()
 
 
166
    def _set_nick(self, nick):
 
 
167
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
 
 
169
    nick = property(_get_nick, _set_nick)
 
 
172
        raise NotImplementedError(self.is_locked)
 
 
174
    def lock_write(self):
 
 
175
        raise NotImplementedError(self.lock_write)
 
 
178
        raise NotImplementedError(self.lock_read)
 
 
181
        raise NotImplementedError(self.unlock)
 
 
183
    def peek_lock_mode(self):
 
 
184
        """Return lock mode for the Branch: 'r', 'w' or None"""
 
 
185
        raise NotImplementedError(self.peek_lock_mode)
 
 
187
    def get_physical_lock_status(self):
 
 
188
        raise NotImplementedError(self.get_physical_lock_status)
 
 
191
    def get_revision_id_to_revno_map(self):
 
 
192
        """Return the revision_id => dotted revno map.
 
 
194
        This will be regenerated on demand, but will be cached.
 
 
196
        :return: A dictionary mapping revision_id => dotted revno.
 
 
197
            This dictionary should not be modified by the caller.
 
 
199
        if self._revision_id_to_revno_cache is not None:
 
 
200
            mapping = self._revision_id_to_revno_cache
 
 
202
            mapping = self._gen_revno_map()
 
 
203
            self._cache_revision_id_to_revno(mapping)
 
 
204
        # TODO: jam 20070417 Since this is being cached, should we be returning
 
 
206
        # I would rather not, and instead just declare that users should not
 
 
207
        # modify the return value.
 
 
210
    def _gen_revno_map(self):
 
 
211
        """Create a new mapping from revision ids to dotted revnos.
 
 
213
        Dotted revnos are generated based on the current tip in the revision
 
 
215
        This is the worker function for get_revision_id_to_revno_map, which
 
 
216
        just caches the return value.
 
 
218
        :return: A dictionary mapping revision_id => dotted revno.
 
 
220
        last_revision = self.last_revision()
 
 
221
        revision_graph = repository._old_get_graph(self.repository,
 
 
223
        merge_sorted_revisions = tsort.merge_sort(
 
 
228
        revision_id_to_revno = dict((rev_id, revno)
 
 
229
                                    for seq_num, rev_id, depth, revno, end_of_merge
 
 
230
                                     in merge_sorted_revisions)
 
 
231
        return revision_id_to_revno
 
 
233
    def leave_lock_in_place(self):
 
 
234
        """Tell this branch object not to release the physical lock when this
 
 
237
        If lock_write doesn't return a token, then this method is not supported.
 
 
239
        self.control_files.leave_in_place()
 
 
241
    def dont_leave_lock_in_place(self):
 
 
242
        """Tell this branch object to release the physical lock when this
 
 
243
        object is unlocked, even if it didn't originally acquire it.
 
 
245
        If lock_write doesn't return a token, then this method is not supported.
 
 
247
        self.control_files.dont_leave_in_place()
 
 
249
    def bind(self, other):
 
 
250
        """Bind the local branch the other branch.
 
 
252
        :param other: The branch to bind to
 
 
255
        raise errors.UpgradeRequired(self.base)
 
 
258
    def fetch(self, from_branch, last_revision=None, pb=None):
 
 
259
        """Copy revisions from from_branch into this branch.
 
 
261
        :param from_branch: Where to copy from.
 
 
262
        :param last_revision: What revision to stop at (None for at the end
 
 
264
        :param pb: An optional progress bar to use.
 
 
266
        Returns the copied revision count and the failed revisions in a tuple:
 
 
269
        if self.base == from_branch.base:
 
 
272
            nested_pb = ui.ui_factory.nested_progress_bar()
 
 
277
        from_branch.lock_read()
 
 
279
            if last_revision is None:
 
 
280
                pb.update('get source history')
 
 
281
                last_revision = from_branch.last_revision()
 
 
282
                last_revision = _mod_revision.ensure_null(last_revision)
 
 
283
            return self.repository.fetch(from_branch.repository,
 
 
284
                                         revision_id=last_revision,
 
 
287
            if nested_pb is not None:
 
 
291
    def get_bound_location(self):
 
 
292
        """Return the URL of the branch we are bound to.
 
 
294
        Older format branches cannot bind, please be sure to use a metadir
 
 
299
    def get_old_bound_location(self):
 
 
300
        """Return the URL of the branch we used to be bound to
 
 
302
        raise errors.UpgradeRequired(self.base)
 
 
304
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
 
305
                           timezone=None, committer=None, revprops=None, 
 
 
307
        """Obtain a CommitBuilder for this branch.
 
 
309
        :param parents: Revision ids of the parents of the new revision.
 
 
310
        :param config: Optional configuration to use.
 
 
311
        :param timestamp: Optional timestamp recorded for commit.
 
 
312
        :param timezone: Optional timezone for timestamp.
 
 
313
        :param committer: Optional committer to set for commit.
 
 
314
        :param revprops: Optional dictionary of revision properties.
 
 
315
        :param revision_id: Optional revision id.
 
 
319
            config = self.get_config()
 
 
321
        return self.repository.get_commit_builder(self, parents, config,
 
 
322
            timestamp, timezone, committer, revprops, revision_id)
 
 
324
    def get_master_branch(self, possible_transports=None):
 
 
325
        """Return the branch we are bound to.
 
 
327
        :return: Either a Branch, or None
 
 
331
    def get_revision_delta(self, revno):
 
 
332
        """Return the delta for one revision.
 
 
334
        The delta is relative to its mainline predecessor, or the
 
 
335
        empty tree for revision 1.
 
 
337
        rh = self.revision_history()
 
 
338
        if not (1 <= revno <= len(rh)):
 
 
339
            raise errors.InvalidRevisionNumber(revno)
 
 
340
        return self.repository.get_revision_delta(rh[revno-1])
 
 
342
    def get_stacked_on_url(self):
 
 
343
        """Get the URL this branch is stacked against.
 
 
345
        :raises NotStacked: If the branch is not stacked.
 
 
346
        :raises UnstackableBranchFormat: If the branch does not support
 
 
349
        raise NotImplementedError(self.get_stacked_on_url)
 
 
351
    def print_file(self, file, revision_id):
 
 
352
        """Print `file` to stdout."""
 
 
353
        raise NotImplementedError(self.print_file)
 
 
355
    def set_revision_history(self, rev_history):
 
 
356
        raise NotImplementedError(self.set_revision_history)
 
 
358
    def set_stacked_on_url(self, url):
 
 
359
        """Set the URL this branch is stacked against.
 
 
361
        :raises UnstackableBranchFormat: If the branch does not support
 
 
363
        :raises UnstackableRepositoryFormat: If the repository does not support
 
 
366
        raise NotImplementedError(self.set_stacked_on_url)
 
 
368
    def _cache_revision_history(self, rev_history):
 
 
369
        """Set the cached revision history to rev_history.
 
 
371
        The revision_history method will use this cache to avoid regenerating
 
 
372
        the revision history.
 
 
374
        This API is semi-public; it only for use by subclasses, all other code
 
 
375
        should consider it to be private.
 
 
377
        self._revision_history_cache = rev_history
 
 
379
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
 
 
380
        """Set the cached revision_id => revno map to revision_id_to_revno.
 
 
382
        This API is semi-public; it only for use by subclasses, all other code
 
 
383
        should consider it to be private.
 
 
385
        self._revision_id_to_revno_cache = revision_id_to_revno
 
 
387
    def _clear_cached_state(self):
 
 
388
        """Clear any cached data on this branch, e.g. cached revision history.
 
 
390
        This means the next call to revision_history will need to call
 
 
391
        _gen_revision_history.
 
 
393
        This API is semi-public; it only for use by subclasses, all other code
 
 
394
        should consider it to be private.
 
 
396
        self._revision_history_cache = None
 
 
397
        self._revision_id_to_revno_cache = None
 
 
398
        self._last_revision_info_cache = None
 
 
400
    def _gen_revision_history(self):
 
 
401
        """Return sequence of revision hashes on to this branch.
 
 
403
        Unlike revision_history, this method always regenerates or rereads the
 
 
404
        revision history, i.e. it does not cache the result, so repeated calls
 
 
407
        Concrete subclasses should override this instead of revision_history so
 
 
408
        that subclasses do not need to deal with caching logic.
 
 
410
        This API is semi-public; it only for use by subclasses, all other code
 
 
411
        should consider it to be private.
 
 
413
        raise NotImplementedError(self._gen_revision_history)
 
 
416
    def revision_history(self):
 
 
417
        """Return sequence of revision ids on this branch.
 
 
419
        This method will cache the revision history for as long as it is safe to
 
 
422
        if 'evil' in debug.debug_flags:
 
 
423
            mutter_callsite(3, "revision_history scales with history.")
 
 
424
        if self._revision_history_cache is not None:
 
 
425
            history = self._revision_history_cache
 
 
427
            history = self._gen_revision_history()
 
 
428
            self._cache_revision_history(history)
 
 
432
        """Return current revision number for this branch.
 
 
434
        That is equivalent to the number of revisions committed to
 
 
437
        return self.last_revision_info()[0]
 
 
440
        """Older format branches cannot bind or unbind."""
 
 
441
        raise errors.UpgradeRequired(self.base)
 
 
443
    def set_append_revisions_only(self, enabled):
 
 
444
        """Older format branches are never restricted to append-only"""
 
 
445
        raise errors.UpgradeRequired(self.base)
 
 
447
    def last_revision(self):
 
 
448
        """Return last revision id, or NULL_REVISION."""
 
 
449
        return self.last_revision_info()[1]
 
 
452
    def last_revision_info(self):
 
 
453
        """Return information about the last revision.
 
 
455
        :return: A tuple (revno, revision_id).
 
 
457
        if self._last_revision_info_cache is None:
 
 
458
            self._last_revision_info_cache = self._last_revision_info()
 
 
459
        return self._last_revision_info_cache
 
 
461
    def _last_revision_info(self):
 
 
462
        rh = self.revision_history()
 
 
465
            return (revno, rh[-1])
 
 
467
            return (0, _mod_revision.NULL_REVISION)
 
 
469
    @deprecated_method(deprecated_in((1, 6, 0)))
 
 
470
    def missing_revisions(self, other, stop_revision=None):
 
 
471
        """Return a list of new revisions that would perfectly fit.
 
 
473
        If self and other have not diverged, return a list of the revisions
 
 
474
        present in other, but missing from self.
 
 
476
        self_history = self.revision_history()
 
 
477
        self_len = len(self_history)
 
 
478
        other_history = other.revision_history()
 
 
479
        other_len = len(other_history)
 
 
480
        common_index = min(self_len, other_len) -1
 
 
481
        if common_index >= 0 and \
 
 
482
            self_history[common_index] != other_history[common_index]:
 
 
483
            raise errors.DivergedBranches(self, other)
 
 
485
        if stop_revision is None:
 
 
486
            stop_revision = other_len
 
 
488
            if stop_revision > other_len:
 
 
489
                raise errors.NoSuchRevision(self, stop_revision)
 
 
490
        return other_history[self_len:stop_revision]
 
 
493
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
 
495
        """Pull in new perfect-fit revisions.
 
 
497
        :param other: Another Branch to pull from
 
 
498
        :param stop_revision: Updated until the given revision
 
 
499
        :param overwrite: Always set the branch pointer, rather than checking
 
 
500
            to see if it is a proper descendant.
 
 
501
        :param graph: A Graph object that can be used to query history
 
 
502
            information. This can be None.
 
 
507
            other_revno, other_last_revision = other.last_revision_info()
 
 
508
            stop_revno = None # unknown
 
 
509
            if stop_revision is None:
 
 
510
                stop_revision = other_last_revision
 
 
511
                if _mod_revision.is_null(stop_revision):
 
 
512
                    # if there are no commits, we're done.
 
 
514
                stop_revno = other_revno
 
 
516
            # what's the current last revision, before we fetch [and change it
 
 
518
            last_rev = _mod_revision.ensure_null(self.last_revision())
 
 
519
            # we fetch here so that we don't process data twice in the common
 
 
520
            # case of having something to pull, and so that the check for 
 
 
521
            # already merged can operate on the just fetched graph, which will
 
 
522
            # be cached in memory.
 
 
523
            self.fetch(other, stop_revision)
 
 
524
            # Check to see if one is an ancestor of the other
 
 
527
                    graph = self.repository.get_graph()
 
 
528
                if self._check_if_descendant_or_diverged(
 
 
529
                        stop_revision, last_rev, graph, other):
 
 
530
                    # stop_revision is a descendant of last_rev, but we aren't
 
 
531
                    # overwriting, so we're done.
 
 
533
            if stop_revno is None:
 
 
535
                    graph = self.repository.get_graph()
 
 
536
                this_revno, this_last_revision = self.last_revision_info()
 
 
537
                stop_revno = graph.find_distance_to_null(stop_revision,
 
 
538
                                [(other_last_revision, other_revno),
 
 
539
                                 (this_last_revision, this_revno)])
 
 
540
            self.set_last_revision_info(stop_revno, stop_revision)
 
 
544
    def revision_id_to_revno(self, revision_id):
 
 
545
        """Given a revision id, return its revno"""
 
 
546
        if _mod_revision.is_null(revision_id):
 
 
548
        history = self.revision_history()
 
 
550
            return history.index(revision_id) + 1
 
 
552
            raise errors.NoSuchRevision(self, revision_id)
 
 
554
    def get_rev_id(self, revno, history=None):
 
 
555
        """Find the revision id of the specified revno."""
 
 
557
            return _mod_revision.NULL_REVISION
 
 
559
            history = self.revision_history()
 
 
560
        if revno <= 0 or revno > len(history):
 
 
561
            raise errors.NoSuchRevision(self, revno)
 
 
562
        return history[revno - 1]
 
 
564
    def pull(self, source, overwrite=False, stop_revision=None,
 
 
565
             possible_transports=None, _override_hook_target=None):
 
 
566
        """Mirror source into this branch.
 
 
568
        This branch is considered to be 'local', having low latency.
 
 
570
        :returns: PullResult instance
 
 
572
        raise NotImplementedError(self.pull)
 
 
574
    def push(self, target, overwrite=False, stop_revision=None):
 
 
575
        """Mirror this branch into target.
 
 
577
        This branch is considered to be 'local', having low latency.
 
 
579
        raise NotImplementedError(self.push)
 
 
581
    def basis_tree(self):
 
 
582
        """Return `Tree` object for last revision."""
 
 
583
        return self.repository.revision_tree(self.last_revision())
 
 
585
    def get_parent(self):
 
 
586
        """Return the parent location of the branch.
 
 
588
        This is the default location for push/pull/missing.  The usual
 
 
589
        pattern is that the user can override it by specifying a
 
 
592
        raise NotImplementedError(self.get_parent)
 
 
594
    def _set_config_location(self, name, url, config=None,
 
 
595
                             make_relative=False):
 
 
597
            config = self.get_config()
 
 
601
            url = urlutils.relative_url(self.base, url)
 
 
602
        config.set_user_option(name, url, warn_masked=True)
 
 
604
    def _get_config_location(self, name, config=None):
 
 
606
            config = self.get_config()
 
 
607
        location = config.get_user_option(name)
 
 
612
    def get_submit_branch(self):
 
 
613
        """Return the submit location of the branch.
 
 
615
        This is the default location for bundle.  The usual
 
 
616
        pattern is that the user can override it by specifying a
 
 
619
        return self.get_config().get_user_option('submit_branch')
 
 
621
    def set_submit_branch(self, location):
 
 
622
        """Return the submit location of the branch.
 
 
624
        This is the default location for bundle.  The usual
 
 
625
        pattern is that the user can override it by specifying a
 
 
628
        self.get_config().set_user_option('submit_branch', location,
 
 
631
    def get_public_branch(self):
 
 
632
        """Return the public location of the branch.
 
 
634
        This is is used by merge directives.
 
 
636
        return self._get_config_location('public_branch')
 
 
638
    def set_public_branch(self, location):
 
 
639
        """Return the submit location of the branch.
 
 
641
        This is the default location for bundle.  The usual
 
 
642
        pattern is that the user can override it by specifying a
 
 
645
        self._set_config_location('public_branch', location)
 
 
647
    def get_push_location(self):
 
 
648
        """Return the None or the location to push this branch to."""
 
 
649
        push_loc = self.get_config().get_user_option('push_location')
 
 
652
    def set_push_location(self, location):
 
 
653
        """Set a new push location for this branch."""
 
 
654
        raise NotImplementedError(self.set_push_location)
 
 
656
    def set_parent(self, url):
 
 
657
        raise NotImplementedError(self.set_parent)
 
 
661
        """Synchronise this branch with the master branch if any. 
 
 
663
        :return: None or the last_revision pivoted out during the update.
 
 
667
    def check_revno(self, revno):
 
 
669
        Check whether a revno corresponds to any revision.
 
 
670
        Zero (the NULL revision) is considered valid.
 
 
673
            self.check_real_revno(revno)
 
 
675
    def check_real_revno(self, revno):
 
 
677
        Check whether a revno corresponds to a real revision.
 
 
678
        Zero (the NULL revision) is considered invalid
 
 
680
        if revno < 1 or revno > self.revno():
 
 
681
            raise errors.InvalidRevisionNumber(revno)
 
 
684
    def clone(self, to_bzrdir, revision_id=None):
 
 
685
        """Clone this branch into to_bzrdir preserving all semantic values.
 
 
687
        revision_id: if not None, the revision history in the new branch will
 
 
688
                     be truncated to end with revision_id.
 
 
690
        result = to_bzrdir.create_branch()
 
 
691
        self.copy_content_into(result, revision_id=revision_id)
 
 
695
    def sprout(self, to_bzrdir, revision_id=None):
 
 
696
        """Create a new line of development from the branch, into to_bzrdir.
 
 
698
        to_bzrdir controls the branch format.
 
 
700
        revision_id: if not None, the revision history in the new branch will
 
 
701
                     be truncated to end with revision_id.
 
 
703
        result = to_bzrdir.create_branch()
 
 
704
        self.copy_content_into(result, revision_id=revision_id)
 
 
705
        result.set_parent(self.bzrdir.root_transport.base)
 
 
708
    def _synchronize_history(self, destination, revision_id):
 
 
709
        """Synchronize last revision and revision history between branches.
 
 
711
        This version is most efficient when the destination is also a
 
 
712
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
 
713
        history is the true lefthand parent history, and all of the revisions
 
 
714
        are in the destination's repository.  If not, set_revision_history
 
 
717
        :param destination: The branch to copy the history into
 
 
718
        :param revision_id: The revision-id to truncate history at.  May
 
 
719
          be None to copy complete history.
 
 
721
        if revision_id == _mod_revision.NULL_REVISION:
 
 
724
            new_history = self.revision_history()
 
 
725
        if revision_id is not None and new_history != []:
 
 
727
                new_history = new_history[:new_history.index(revision_id) + 1]
 
 
729
                rev = self.repository.get_revision(revision_id)
 
 
730
                new_history = rev.get_history(self.repository)[1:]
 
 
731
        destination.set_revision_history(new_history)
 
 
734
    def copy_content_into(self, destination, revision_id=None):
 
 
735
        """Copy the content of self into destination.
 
 
737
        revision_id: if not None, the revision history in the new branch will
 
 
738
                     be truncated to end with revision_id.
 
 
740
        self._synchronize_history(destination, revision_id)
 
 
742
            parent = self.get_parent()
 
 
743
        except errors.InaccessibleParent, e:
 
 
744
            mutter('parent was not accessible to copy: %s', e)
 
 
747
                destination.set_parent(parent)
 
 
748
        self.tags.merge_to(destination.tags)
 
 
752
        """Check consistency of the branch.
 
 
754
        In particular this checks that revisions given in the revision-history
 
 
755
        do actually match up in the revision graph, and that they're all 
 
 
756
        present in the repository.
 
 
758
        Callers will typically also want to check the repository.
 
 
760
        :return: A BranchCheckResult.
 
 
762
        mainline_parent_id = None
 
 
763
        last_revno, last_revision_id = self.last_revision_info()
 
 
764
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
 
766
        real_rev_history.reverse()
 
 
767
        if len(real_rev_history) != last_revno:
 
 
768
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
 
769
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
 
770
        # TODO: We should probably also check that real_rev_history actually
 
 
771
        #       matches self.revision_history()
 
 
772
        for revision_id in real_rev_history:
 
 
774
                revision = self.repository.get_revision(revision_id)
 
 
775
            except errors.NoSuchRevision, e:
 
 
776
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
 
778
            # In general the first entry on the revision history has no parents.
 
 
779
            # But it's not illegal for it to have parents listed; this can happen
 
 
780
            # in imports from Arch when the parents weren't reachable.
 
 
781
            if mainline_parent_id is not None:
 
 
782
                if mainline_parent_id not in revision.parent_ids:
 
 
783
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
 
785
                                        % (mainline_parent_id, revision_id))
 
 
786
            mainline_parent_id = revision_id
 
 
787
        return BranchCheckResult(self)
 
 
789
    def _get_checkout_format(self):
 
 
790
        """Return the most suitable metadir for a checkout of this branch.
 
 
791
        Weaves are used if this branch's repository uses weaves.
 
 
793
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
 
794
            from bzrlib.repofmt import weaverepo
 
 
795
            format = bzrdir.BzrDirMetaFormat1()
 
 
796
            format.repository_format = weaverepo.RepositoryFormat7()
 
 
798
            format = self.repository.bzrdir.checkout_metadir()
 
 
799
            format.set_branch_format(self._format)
 
 
802
    def create_checkout(self, to_location, revision_id=None,
 
 
803
                        lightweight=False, accelerator_tree=None,
 
 
805
        """Create a checkout of a branch.
 
 
807
        :param to_location: The url to produce the checkout at
 
 
808
        :param revision_id: The revision to check out
 
 
809
        :param lightweight: If True, produce a lightweight checkout, otherwise,
 
 
810
        produce a bound branch (heavyweight checkout)
 
 
811
        :param accelerator_tree: A tree which can be used for retrieving file
 
 
812
            contents more quickly than the revision tree, i.e. a workingtree.
 
 
813
            The revision tree will be used for cases where accelerator_tree's
 
 
814
            content is different.
 
 
815
        :param hardlink: If true, hard-link files from accelerator_tree,
 
 
817
        :return: The tree of the created checkout
 
 
819
        t = transport.get_transport(to_location)
 
 
822
            format = self._get_checkout_format()
 
 
823
            checkout = format.initialize_on_transport(t)
 
 
824
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
 
826
            format = self._get_checkout_format()
 
 
827
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
 
828
                to_location, force_new_tree=False, format=format)
 
 
829
            checkout = checkout_branch.bzrdir
 
 
830
            checkout_branch.bind(self)
 
 
831
            # pull up to the specified revision_id to set the initial 
 
 
832
            # branch tip correctly, and seed it with history.
 
 
833
            checkout_branch.pull(self, stop_revision=revision_id)
 
 
835
        tree = checkout.create_workingtree(revision_id,
 
 
836
                                           from_branch=from_branch,
 
 
837
                                           accelerator_tree=accelerator_tree,
 
 
839
        basis_tree = tree.basis_tree()
 
 
840
        basis_tree.lock_read()
 
 
842
            for path, file_id in basis_tree.iter_references():
 
 
843
                reference_parent = self.reference_parent(file_id, path)
 
 
844
                reference_parent.create_checkout(tree.abspath(path),
 
 
845
                    basis_tree.get_reference_revision(file_id, path),
 
 
852
    def reconcile(self, thorough=True):
 
 
853
        """Make sure the data stored in this branch is consistent."""
 
 
854
        from bzrlib.reconcile import BranchReconciler
 
 
855
        reconciler = BranchReconciler(self, thorough=thorough)
 
 
856
        reconciler.reconcile()
 
 
859
    def reference_parent(self, file_id, path):
 
 
860
        """Return the parent branch for a tree-reference file_id
 
 
861
        :param file_id: The file_id of the tree reference
 
 
862
        :param path: The path of the file_id in the tree
 
 
863
        :return: A branch associated with the file_id
 
 
865
        # FIXME should provide multiple branches, based on config
 
 
866
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
 
 
868
    def supports_tags(self):
 
 
869
        return self._format.supports_tags()
 
 
871
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
 
 
873
        """Ensure that revision_b is a descendant of revision_a.
 
 
875
        This is a helper function for update_revisions.
 
 
877
        :raises: DivergedBranches if revision_b has diverged from revision_a.
 
 
878
        :returns: True if revision_b is a descendant of revision_a.
 
 
880
        relation = self._revision_relations(revision_a, revision_b, graph)
 
 
881
        if relation == 'b_descends_from_a':
 
 
883
        elif relation == 'diverged':
 
 
884
            raise errors.DivergedBranches(self, other_branch)
 
 
885
        elif relation == 'a_descends_from_b':
 
 
888
            raise AssertionError("invalid relation: %r" % (relation,))
 
 
890
    def _revision_relations(self, revision_a, revision_b, graph):
 
 
891
        """Determine the relationship between two revisions.
 
 
893
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
 
 
895
        heads = graph.heads([revision_a, revision_b])
 
 
896
        if heads == set([revision_b]):
 
 
897
            return 'b_descends_from_a'
 
 
898
        elif heads == set([revision_a, revision_b]):
 
 
899
            # These branches have diverged
 
 
901
        elif heads == set([revision_a]):
 
 
902
            return 'a_descends_from_b'
 
 
904
            raise AssertionError("invalid heads: %r" % (heads,))
 
 
907
class BranchFormat(object):
 
 
908
    """An encapsulation of the initialization and open routines for a format.
 
 
910
    Formats provide three things:
 
 
911
     * An initialization routine,
 
 
915
    Formats are placed in an dict by their format string for reference 
 
 
916
    during branch opening. Its not required that these be instances, they
 
 
917
    can be classes themselves with class methods - it simply depends on 
 
 
918
    whether state is needed for a given format or not.
 
 
920
    Once a format is deprecated, just deprecate the initialize and open
 
 
921
    methods on the format class. Do not deprecate the object, as the 
 
 
922
    object will be created every time regardless.
 
 
925
    _default_format = None
 
 
926
    """The default format used for new branches."""
 
 
929
    """The known formats."""
 
 
931
    def __eq__(self, other):
 
 
932
        return self.__class__ is other.__class__
 
 
934
    def __ne__(self, other):
 
 
935
        return not (self == other)
 
 
938
    def find_format(klass, a_bzrdir):
 
 
939
        """Return the format for the branch object in a_bzrdir."""
 
 
941
            transport = a_bzrdir.get_branch_transport(None)
 
 
942
            format_string = transport.get("format").read()
 
 
943
            return klass._formats[format_string]
 
 
944
        except errors.NoSuchFile:
 
 
945
            raise errors.NotBranchError(path=transport.base)
 
 
947
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
 
950
    def get_default_format(klass):
 
 
951
        """Return the current default format."""
 
 
952
        return klass._default_format
 
 
954
    def get_reference(self, a_bzrdir):
 
 
955
        """Get the target reference of the branch in a_bzrdir.
 
 
957
        format probing must have been completed before calling
 
 
958
        this method - it is assumed that the format of the branch
 
 
959
        in a_bzrdir is correct.
 
 
961
        :param a_bzrdir: The bzrdir to get the branch data from.
 
 
962
        :return: None if the branch is not a reference branch.
 
 
967
    def set_reference(self, a_bzrdir, to_branch):
 
 
968
        """Set the target reference of the branch in a_bzrdir.
 
 
970
        format probing must have been completed before calling
 
 
971
        this method - it is assumed that the format of the branch
 
 
972
        in a_bzrdir is correct.
 
 
974
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
 
975
        :param to_branch: branch that the checkout is to reference
 
 
977
        raise NotImplementedError(self.set_reference)
 
 
979
    def get_format_string(self):
 
 
980
        """Return the ASCII format string that identifies this format."""
 
 
981
        raise NotImplementedError(self.get_format_string)
 
 
983
    def get_format_description(self):
 
 
984
        """Return the short format description for this format."""
 
 
985
        raise NotImplementedError(self.get_format_description)
 
 
987
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
 
989
        """Initialize a branch in a bzrdir, with specified files
 
 
991
        :param a_bzrdir: The bzrdir to initialize the branch in
 
 
992
        :param utf8_files: The files to create as a list of
 
 
993
            (filename, content) tuples
 
 
994
        :param set_format: If True, set the format with
 
 
995
            self.get_format_string.  (BzrBranch4 has its format set
 
 
997
        :return: a branch in this format
 
 
999
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
 
1000
        branch_transport = a_bzrdir.get_branch_transport(self)
 
 
1002
            'metadir': ('lock', lockdir.LockDir),
 
 
1003
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
 
1005
        lock_name, lock_class = lock_map[lock_type]
 
 
1006
        control_files = lockable_files.LockableFiles(branch_transport,
 
 
1007
            lock_name, lock_class)
 
 
1008
        control_files.create_lock()
 
 
1009
        control_files.lock_write()
 
 
1011
            utf8_files += [('format', self.get_format_string())]
 
 
1013
            for (filename, content) in utf8_files:
 
 
1014
                branch_transport.put_bytes(
 
 
1016
                    mode=a_bzrdir._get_file_mode())
 
 
1018
            control_files.unlock()
 
 
1019
        return self.open(a_bzrdir, _found=True)
 
 
1021
    def initialize(self, a_bzrdir):
 
 
1022
        """Create a branch of this format in a_bzrdir."""
 
 
1023
        raise NotImplementedError(self.initialize)
 
 
1025
    def is_supported(self):
 
 
1026
        """Is this format supported?
 
 
1028
        Supported formats can be initialized and opened.
 
 
1029
        Unsupported formats may not support initialization or committing or 
 
 
1030
        some other features depending on the reason for not being supported.
 
 
1034
    def open(self, a_bzrdir, _found=False):
 
 
1035
        """Return the branch object for a_bzrdir
 
 
1037
        _found is a private parameter, do not use it. It is used to indicate
 
 
1038
               if format probing has already be done.
 
 
1040
        raise NotImplementedError(self.open)
 
 
1043
    def register_format(klass, format):
 
 
1044
        klass._formats[format.get_format_string()] = format
 
 
1047
    def set_default_format(klass, format):
 
 
1048
        klass._default_format = format
 
 
1050
    def supports_stacking(self):
 
 
1051
        """True if this format records a stacked-on branch."""
 
 
1055
    def unregister_format(klass, format):
 
 
1056
        del klass._formats[format.get_format_string()]
 
 
1059
        return self.get_format_string().rstrip()
 
 
1061
    def supports_tags(self):
 
 
1062
        """True if this format supports tags stored in the branch"""
 
 
1063
        return False  # by default
 
 
1066
class BranchHooks(Hooks):
 
 
1067
    """A dictionary mapping hook name to a list of callables for branch hooks.
 
 
1069
    e.g. ['set_rh'] Is the list of items to be called when the
 
 
1070
    set_revision_history function is invoked.
 
 
1074
        """Create the default hooks.
 
 
1076
        These are all empty initially, because by default nothing should get
 
 
1079
        Hooks.__init__(self)
 
 
1080
        # Introduced in 0.15:
 
 
1081
        # invoked whenever the revision history has been set
 
 
1082
        # with set_revision_history. The api signature is
 
 
1083
        # (branch, revision_history), and the branch will
 
 
1086
        # Invoked after a branch is opened. The api signature is (branch).
 
 
1088
        # invoked after a push operation completes.
 
 
1089
        # the api signature is
 
 
1091
        # containing the members
 
 
1092
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
 
1093
        # where local is the local target branch or None, master is the target 
 
 
1094
        # master branch, and the rest should be self explanatory. The source
 
 
1095
        # is read locked and the target branches write locked. Source will
 
 
1096
        # be the local low-latency branch.
 
 
1097
        self['post_push'] = []
 
 
1098
        # invoked after a pull operation completes.
 
 
1099
        # the api signature is
 
 
1101
        # containing the members
 
 
1102
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
 
1103
        # where local is the local branch or None, master is the target 
 
 
1104
        # master branch, and the rest should be self explanatory. The source
 
 
1105
        # is read locked and the target branches write locked. The local
 
 
1106
        # branch is the low-latency branch.
 
 
1107
        self['post_pull'] = []
 
 
1108
        # invoked before a commit operation takes place.
 
 
1109
        # the api signature is
 
 
1110
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
 
1111
        #  tree_delta, future_tree).
 
 
1112
        # old_revid is NULL_REVISION for the first commit to a branch
 
 
1113
        # tree_delta is a TreeDelta object describing changes from the basis
 
 
1114
        # revision, hooks MUST NOT modify this delta
 
 
1115
        # future_tree is an in-memory tree obtained from
 
 
1116
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
 
1117
        self['pre_commit'] = []
 
 
1118
        # invoked after a commit operation completes.
 
 
1119
        # the api signature is 
 
 
1120
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
 
1121
        # old_revid is NULL_REVISION for the first commit to a branch.
 
 
1122
        self['post_commit'] = []
 
 
1123
        # invoked after a uncommit operation completes.
 
 
1124
        # the api signature is
 
 
1125
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
 
1126
        # local is the local branch or None, master is the target branch,
 
 
1127
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
 
1128
        self['post_uncommit'] = []
 
 
1130
        # Invoked before the tip of a branch changes.
 
 
1131
        # the api signature is
 
 
1132
        # (params) where params is a ChangeBranchTipParams with the members
 
 
1133
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
 
1134
        self['pre_change_branch_tip'] = []
 
 
1136
        # Invoked after the tip of a branch changes.
 
 
1137
        # the api signature is
 
 
1138
        # (params) where params is a ChangeBranchTipParams with the members
 
 
1139
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
 
1140
        self['post_change_branch_tip'] = []
 
 
1142
        # Invoked when a stacked branch activates its fallback locations and
 
 
1143
        # allows the transformation of the url of said location.
 
 
1144
        # the api signature is
 
 
1145
        # (branch, url) where branch is the branch having its fallback
 
 
1146
        # location activated and url is the url for the fallback location.
 
 
1147
        # The hook should return a url.
 
 
1148
        self['transform_fallback_location'] = []
 
 
1151
# install the default hooks into the Branch class.
 
 
1152
Branch.hooks = BranchHooks()
 
 
1155
class ChangeBranchTipParams(object):
 
 
1156
    """Object holding parameters passed to *_change_branch_tip hooks.
 
 
1158
    There are 5 fields that hooks may wish to access:
 
 
1160
    :ivar branch: the branch being changed
 
 
1161
    :ivar old_revno: revision number before the change
 
 
1162
    :ivar new_revno: revision number after the change
 
 
1163
    :ivar old_revid: revision id before the change
 
 
1164
    :ivar new_revid: revision id after the change
 
 
1166
    The revid fields are strings. The revno fields are integers.
 
 
1169
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
 
 
1170
        """Create a group of ChangeBranchTip parameters.
 
 
1172
        :param branch: The branch being changed.
 
 
1173
        :param old_revno: Revision number before the change.
 
 
1174
        :param new_revno: Revision number after the change.
 
 
1175
        :param old_revid: Tip revision id before the change.
 
 
1176
        :param new_revid: Tip revision id after the change.
 
 
1178
        self.branch = branch
 
 
1179
        self.old_revno = old_revno
 
 
1180
        self.new_revno = new_revno
 
 
1181
        self.old_revid = old_revid
 
 
1182
        self.new_revid = new_revid
 
 
1184
    def __eq__(self, other):
 
 
1185
        return self.__dict__ == other.__dict__
 
 
1188
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
 
 
1189
            self.__class__.__name__, self.branch, 
 
 
1190
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
 
 
1193
class BzrBranchFormat4(BranchFormat):
 
 
1194
    """Bzr branch format 4.
 
 
1197
     - a revision-history file.
 
 
1198
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
 
1201
    def get_format_description(self):
 
 
1202
        """See BranchFormat.get_format_description()."""
 
 
1203
        return "Branch format 4"
 
 
1205
    def initialize(self, a_bzrdir):
 
 
1206
        """Create a branch of this format in a_bzrdir."""
 
 
1207
        utf8_files = [('revision-history', ''),
 
 
1208
                      ('branch-name', ''),
 
 
1210
        return self._initialize_helper(a_bzrdir, utf8_files,
 
 
1211
                                       lock_type='branch4', set_format=False)
 
 
1214
        super(BzrBranchFormat4, self).__init__()
 
 
1215
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
 
1217
    def open(self, a_bzrdir, _found=False):
 
 
1218
        """Return the branch object for a_bzrdir
 
 
1220
        _found is a private parameter, do not use it. It is used to indicate
 
 
1221
               if format probing has already be done.
 
 
1224
            # we are being called directly and must probe.
 
 
1225
            raise NotImplementedError
 
 
1226
        return BzrBranch(_format=self,
 
 
1227
                         _control_files=a_bzrdir._control_files,
 
 
1229
                         _repository=a_bzrdir.open_repository())
 
 
1232
        return "Bazaar-NG branch format 4"
 
 
1235
class BranchFormatMetadir(BranchFormat):
 
 
1236
    """Common logic for meta-dir based branch formats."""
 
 
1238
    def _branch_class(self):
 
 
1239
        """What class to instantiate on open calls."""
 
 
1240
        raise NotImplementedError(self._branch_class)
 
 
1242
    def open(self, a_bzrdir, _found=False):
 
 
1243
        """Return the branch object for a_bzrdir.
 
 
1245
        _found is a private parameter, do not use it. It is used to indicate
 
 
1246
               if format probing has already be done.
 
 
1249
            format = BranchFormat.find_format(a_bzrdir)
 
 
1250
            if format.__class__ != self.__class__:
 
 
1251
                raise AssertionError("wrong format %r found for %r" %
 
 
1254
            transport = a_bzrdir.get_branch_transport(None)
 
 
1255
            control_files = lockable_files.LockableFiles(transport, 'lock',
 
 
1257
            return self._branch_class()(_format=self,
 
 
1258
                              _control_files=control_files,
 
 
1260
                              _repository=a_bzrdir.find_repository())
 
 
1261
        except errors.NoSuchFile:
 
 
1262
            raise errors.NotBranchError(path=transport.base)
 
 
1265
        super(BranchFormatMetadir, self).__init__()
 
 
1266
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
 
1268
    def supports_tags(self):
 
 
1272
class BzrBranchFormat5(BranchFormatMetadir):
 
 
1273
    """Bzr branch format 5.
 
 
1276
     - a revision-history file.
 
 
1278
     - a lock dir guarding the branch itself
 
 
1279
     - all of this stored in a branch/ subdirectory
 
 
1280
     - works with shared repositories.
 
 
1282
    This format is new in bzr 0.8.
 
 
1285
    def _branch_class(self):
 
 
1288
    def get_format_string(self):
 
 
1289
        """See BranchFormat.get_format_string()."""
 
 
1290
        return "Bazaar-NG branch format 5\n"
 
 
1292
    def get_format_description(self):
 
 
1293
        """See BranchFormat.get_format_description()."""
 
 
1294
        return "Branch format 5"
 
 
1296
    def initialize(self, a_bzrdir):
 
 
1297
        """Create a branch of this format in a_bzrdir."""
 
 
1298
        utf8_files = [('revision-history', ''),
 
 
1299
                      ('branch-name', ''),
 
 
1301
        return self._initialize_helper(a_bzrdir, utf8_files)
 
 
1303
    def supports_tags(self):
 
 
1307
class BzrBranchFormat6(BranchFormatMetadir):
 
 
1308
    """Branch format with last-revision and tags.
 
 
1310
    Unlike previous formats, this has no explicit revision history. Instead,
 
 
1311
    this just stores the last-revision, and the left-hand history leading
 
 
1312
    up to there is the history.
 
 
1314
    This format was introduced in bzr 0.15
 
 
1315
    and became the default in 0.91.
 
 
1318
    def _branch_class(self):
 
 
1321
    def get_format_string(self):
 
 
1322
        """See BranchFormat.get_format_string()."""
 
 
1323
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
 
 
1325
    def get_format_description(self):
 
 
1326
        """See BranchFormat.get_format_description()."""
 
 
1327
        return "Branch format 6"
 
 
1329
    def initialize(self, a_bzrdir):
 
 
1330
        """Create a branch of this format in a_bzrdir."""
 
 
1331
        utf8_files = [('last-revision', '0 null:\n'),
 
 
1332
                      ('branch.conf', ''),
 
 
1335
        return self._initialize_helper(a_bzrdir, utf8_files)
 
 
1338
class BzrBranchFormat7(BranchFormatMetadir):
 
 
1339
    """Branch format with last-revision, tags, and a stacked location pointer.
 
 
1341
    The stacked location pointer is passed down to the repository and requires
 
 
1342
    a repository format with supports_external_lookups = True.
 
 
1344
    This format was introduced in bzr 1.6.
 
 
1347
    def _branch_class(self):
 
 
1350
    def get_format_string(self):
 
 
1351
        """See BranchFormat.get_format_string()."""
 
 
1352
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
 
 
1354
    def get_format_description(self):
 
 
1355
        """See BranchFormat.get_format_description()."""
 
 
1356
        return "Branch format 7"
 
 
1358
    def initialize(self, a_bzrdir):
 
 
1359
        """Create a branch of this format in a_bzrdir."""
 
 
1360
        utf8_files = [('last-revision', '0 null:\n'),
 
 
1361
                      ('branch.conf', ''),
 
 
1364
        return self._initialize_helper(a_bzrdir, utf8_files)
 
 
1367
        super(BzrBranchFormat7, self).__init__()
 
 
1368
        self._matchingbzrdir.repository_format = \
 
 
1369
            RepositoryFormatKnitPack5RichRoot()
 
 
1371
    def supports_stacking(self):
 
 
1375
class BranchReferenceFormat(BranchFormat):
 
 
1376
    """Bzr branch reference format.
 
 
1378
    Branch references are used in implementing checkouts, they
 
 
1379
    act as an alias to the real branch which is at some other url.
 
 
1386
    def get_format_string(self):
 
 
1387
        """See BranchFormat.get_format_string()."""
 
 
1388
        return "Bazaar-NG Branch Reference Format 1\n"
 
 
1390
    def get_format_description(self):
 
 
1391
        """See BranchFormat.get_format_description()."""
 
 
1392
        return "Checkout reference format 1"
 
 
1394
    def get_reference(self, a_bzrdir):
 
 
1395
        """See BranchFormat.get_reference()."""
 
 
1396
        transport = a_bzrdir.get_branch_transport(None)
 
 
1397
        return transport.get('location').read()
 
 
1399
    def set_reference(self, a_bzrdir, to_branch):
 
 
1400
        """See BranchFormat.set_reference()."""
 
 
1401
        transport = a_bzrdir.get_branch_transport(None)
 
 
1402
        location = transport.put_bytes('location', to_branch.base)
 
 
1404
    def initialize(self, a_bzrdir, target_branch=None):
 
 
1405
        """Create a branch of this format in a_bzrdir."""
 
 
1406
        if target_branch is None:
 
 
1407
            # this format does not implement branch itself, thus the implicit
 
 
1408
            # creation contract must see it as uninitializable
 
 
1409
            raise errors.UninitializableFormat(self)
 
 
1410
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
 
1411
        branch_transport = a_bzrdir.get_branch_transport(self)
 
 
1412
        branch_transport.put_bytes('location',
 
 
1413
            target_branch.bzrdir.root_transport.base)
 
 
1414
        branch_transport.put_bytes('format', self.get_format_string())
 
 
1416
            a_bzrdir, _found=True,
 
 
1417
            possible_transports=[target_branch.bzrdir.root_transport])
 
 
1420
        super(BranchReferenceFormat, self).__init__()
 
 
1421
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
 
1423
    def _make_reference_clone_function(format, a_branch):
 
 
1424
        """Create a clone() routine for a branch dynamically."""
 
 
1425
        def clone(to_bzrdir, revision_id=None):
 
 
1426
            """See Branch.clone()."""
 
 
1427
            return format.initialize(to_bzrdir, a_branch)
 
 
1428
            # cannot obey revision_id limits when cloning a reference ...
 
 
1429
            # FIXME RBC 20060210 either nuke revision_id for clone, or
 
 
1430
            # emit some sort of warning/error to the caller ?!
 
 
1433
    def open(self, a_bzrdir, _found=False, location=None,
 
 
1434
             possible_transports=None):
 
 
1435
        """Return the branch that the branch reference in a_bzrdir points at.
 
 
1437
        _found is a private parameter, do not use it. It is used to indicate
 
 
1438
               if format probing has already be done.
 
 
1441
            format = BranchFormat.find_format(a_bzrdir)
 
 
1442
            if format.__class__ != self.__class__:
 
 
1443
                raise AssertionError("wrong format %r found for %r" %
 
 
1445
        if location is None:
 
 
1446
            location = self.get_reference(a_bzrdir)
 
 
1447
        real_bzrdir = bzrdir.BzrDir.open(
 
 
1448
            location, possible_transports=possible_transports)
 
 
1449
        result = real_bzrdir.open_branch()
 
 
1450
        # this changes the behaviour of result.clone to create a new reference
 
 
1451
        # rather than a copy of the content of the branch.
 
 
1452
        # I did not use a proxy object because that needs much more extensive
 
 
1453
        # testing, and we are only changing one behaviour at the moment.
 
 
1454
        # If we decide to alter more behaviours - i.e. the implicit nickname
 
 
1455
        # then this should be refactored to introduce a tested proxy branch
 
 
1456
        # and a subclass of that for use in overriding clone() and ....
 
 
1458
        result.clone = self._make_reference_clone_function(result)
 
 
1462
# formats which have no format string are not discoverable
 
 
1463
# and not independently creatable, so are not registered.
 
 
1464
__format5 = BzrBranchFormat5()
 
 
1465
__format6 = BzrBranchFormat6()
 
 
1466
__format7 = BzrBranchFormat7()
 
 
1467
BranchFormat.register_format(__format5)
 
 
1468
BranchFormat.register_format(BranchReferenceFormat())
 
 
1469
BranchFormat.register_format(__format6)
 
 
1470
BranchFormat.register_format(__format7)
 
 
1471
BranchFormat.set_default_format(__format6)
 
 
1472
_legacy_formats = [BzrBranchFormat4(),
 
 
1475
class BzrBranch(Branch):
 
 
1476
    """A branch stored in the actual filesystem.
 
 
1478
    Note that it's "local" in the context of the filesystem; it doesn't
 
 
1479
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
 
1480
    it's writable, and can be accessed via the normal filesystem API.
 
 
1482
    :ivar _transport: Transport for file operations on this branch's 
 
 
1483
        control files, typically pointing to the .bzr/branch directory.
 
 
1484
    :ivar repository: Repository for this branch.
 
 
1485
    :ivar base: The url of the base directory for this branch; the one 
 
 
1486
        containing the .bzr directory.
 
 
1489
    def __init__(self, _format=None,
 
 
1490
                 _control_files=None, a_bzrdir=None, _repository=None):
 
 
1491
        """Create new branch object at a particular location."""
 
 
1492
        if a_bzrdir is None:
 
 
1493
            raise ValueError('a_bzrdir must be supplied')
 
 
1495
            self.bzrdir = a_bzrdir
 
 
1496
        self._base = self.bzrdir.transport.clone('..').base
 
 
1497
        # XXX: We should be able to just do
 
 
1498
        #   self.base = self.bzrdir.root_transport.base
 
 
1499
        # but this does not quite work yet -- mbp 20080522
 
 
1500
        self._format = _format
 
 
1501
        if _control_files is None:
 
 
1502
            raise ValueError('BzrBranch _control_files is None')
 
 
1503
        self.control_files = _control_files
 
 
1504
        self._transport = _control_files._transport
 
 
1505
        self.repository = _repository
 
 
1506
        Branch.__init__(self)
 
 
1509
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
 
1513
    def _get_base(self):
 
 
1514
        """Returns the directory containing the control directory."""
 
 
1517
    base = property(_get_base, doc="The URL for the root of this branch.")
 
 
1519
    def is_locked(self):
 
 
1520
        return self.control_files.is_locked()
 
 
1522
    def lock_write(self, token=None):
 
 
1523
        repo_token = self.repository.lock_write()
 
 
1525
            token = self.control_files.lock_write(token=token)
 
 
1527
            self.repository.unlock()
 
 
1531
    def lock_read(self):
 
 
1532
        self.repository.lock_read()
 
 
1534
            self.control_files.lock_read()
 
 
1536
            self.repository.unlock()
 
 
1540
        # TODO: test for failed two phase locks. This is known broken.
 
 
1542
            self.control_files.unlock()
 
 
1544
            self.repository.unlock()
 
 
1545
        if not self.control_files.is_locked():
 
 
1546
            # we just released the lock
 
 
1547
            self._clear_cached_state()
 
 
1549
    def peek_lock_mode(self):
 
 
1550
        if self.control_files._lock_count == 0:
 
 
1553
            return self.control_files._lock_mode
 
 
1555
    def get_physical_lock_status(self):
 
 
1556
        return self.control_files.get_physical_lock_status()
 
 
1559
    def print_file(self, file, revision_id):
 
 
1560
        """See Branch.print_file."""
 
 
1561
        return self.repository.print_file(file, revision_id)
 
 
1563
    def _write_revision_history(self, history):
 
 
1564
        """Factored out of set_revision_history.
 
 
1566
        This performs the actual writing to disk.
 
 
1567
        It is intended to be called by BzrBranch5.set_revision_history."""
 
 
1568
        self._transport.put_bytes(
 
 
1569
            'revision-history', '\n'.join(history),
 
 
1570
            mode=self.bzrdir._get_file_mode())
 
 
1573
    def set_revision_history(self, rev_history):
 
 
1574
        """See Branch.set_revision_history."""
 
 
1575
        if 'evil' in debug.debug_flags:
 
 
1576
            mutter_callsite(3, "set_revision_history scales with history.")
 
 
1577
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
 
1578
        for rev_id in rev_history:
 
 
1579
            check_not_reserved_id(rev_id)
 
 
1580
        if Branch.hooks['post_change_branch_tip']:
 
 
1581
            # Don't calculate the last_revision_info() if there are no hooks
 
 
1583
            old_revno, old_revid = self.last_revision_info()
 
 
1584
        if len(rev_history) == 0:
 
 
1585
            revid = _mod_revision.NULL_REVISION
 
 
1587
            revid = rev_history[-1]
 
 
1588
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
 
1589
        self._write_revision_history(rev_history)
 
 
1590
        self._clear_cached_state()
 
 
1591
        self._cache_revision_history(rev_history)
 
 
1592
        for hook in Branch.hooks['set_rh']:
 
 
1593
            hook(self, rev_history)
 
 
1594
        if Branch.hooks['post_change_branch_tip']:
 
 
1595
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
 
1597
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
 
1598
        """Run the pre_change_branch_tip hooks."""
 
 
1599
        hooks = Branch.hooks['pre_change_branch_tip']
 
 
1602
        old_revno, old_revid = self.last_revision_info()
 
 
1603
        params = ChangeBranchTipParams(
 
 
1604
            self, old_revno, new_revno, old_revid, new_revid)
 
 
1608
            except errors.TipChangeRejected:
 
 
1611
                exc_info = sys.exc_info()
 
 
1612
                hook_name = Branch.hooks.get_hook_name(hook)
 
 
1613
                raise errors.HookFailed(
 
 
1614
                    'pre_change_branch_tip', hook_name, exc_info)
 
 
1616
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
 
1617
        """Run the post_change_branch_tip hooks."""
 
 
1618
        hooks = Branch.hooks['post_change_branch_tip']
 
 
1621
        new_revno, new_revid = self.last_revision_info()
 
 
1622
        params = ChangeBranchTipParams(
 
 
1623
            self, old_revno, new_revno, old_revid, new_revid)
 
 
1628
    def set_last_revision_info(self, revno, revision_id):
 
 
1629
        """Set the last revision of this branch.
 
 
1631
        The caller is responsible for checking that the revno is correct
 
 
1632
        for this revision id.
 
 
1634
        It may be possible to set the branch last revision to an id not
 
 
1635
        present in the repository.  However, branches can also be 
 
 
1636
        configured to check constraints on history, in which case this may not
 
 
1639
        revision_id = _mod_revision.ensure_null(revision_id)
 
 
1640
        # this old format stores the full history, but this api doesn't
 
 
1641
        # provide it, so we must generate, and might as well check it's
 
 
1643
        history = self._lefthand_history(revision_id)
 
 
1644
        if len(history) != revno:
 
 
1645
            raise AssertionError('%d != %d' % (len(history), revno))
 
 
1646
        self.set_revision_history(history)
 
 
1648
    def _gen_revision_history(self):
 
 
1649
        history = self._transport.get_bytes('revision-history').split('\n')
 
 
1650
        if history[-1:] == ['']:
 
 
1651
            # There shouldn't be a trailing newline, but just in case.
 
 
1655
    def _lefthand_history(self, revision_id, last_rev=None,
 
 
1657
        if 'evil' in debug.debug_flags:
 
 
1658
            mutter_callsite(4, "_lefthand_history scales with history.")
 
 
1659
        # stop_revision must be a descendant of last_revision
 
 
1660
        graph = self.repository.get_graph()
 
 
1661
        if last_rev is not None:
 
 
1662
            if not graph.is_ancestor(last_rev, revision_id):
 
 
1663
                # our previous tip is not merged into stop_revision
 
 
1664
                raise errors.DivergedBranches(self, other_branch)
 
 
1665
        # make a new revision history from the graph
 
 
1666
        parents_map = graph.get_parent_map([revision_id])
 
 
1667
        if revision_id not in parents_map:
 
 
1668
            raise errors.NoSuchRevision(self, revision_id)
 
 
1669
        current_rev_id = revision_id
 
 
1671
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
 
1672
        # Do not include ghosts or graph origin in revision_history
 
 
1673
        while (current_rev_id in parents_map and
 
 
1674
               len(parents_map[current_rev_id]) > 0):
 
 
1675
            check_not_reserved_id(current_rev_id)
 
 
1676
            new_history.append(current_rev_id)
 
 
1677
            current_rev_id = parents_map[current_rev_id][0]
 
 
1678
            parents_map = graph.get_parent_map([current_rev_id])
 
 
1679
        new_history.reverse()
 
 
1683
    def generate_revision_history(self, revision_id, last_rev=None,
 
 
1685
        """Create a new revision history that will finish with revision_id.
 
 
1687
        :param revision_id: the new tip to use.
 
 
1688
        :param last_rev: The previous last_revision. If not None, then this
 
 
1689
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
 
1690
        :param other_branch: The other branch that DivergedBranches should
 
 
1691
            raise with respect to.
 
 
1693
        self.set_revision_history(self._lefthand_history(revision_id,
 
 
1694
            last_rev, other_branch))
 
 
1696
    def basis_tree(self):
 
 
1697
        """See Branch.basis_tree."""
 
 
1698
        return self.repository.revision_tree(self.last_revision())
 
 
1701
    def pull(self, source, overwrite=False, stop_revision=None,
 
 
1702
             _hook_master=None, run_hooks=True, possible_transports=None,
 
 
1703
             _override_hook_target=None):
 
 
1706
        :param _hook_master: Private parameter - set the branch to 
 
 
1707
            be supplied as the master to pull hooks.
 
 
1708
        :param run_hooks: Private parameter - if false, this branch
 
 
1709
            is being called because it's the master of the primary branch,
 
 
1710
            so it should not run its hooks.
 
 
1711
        :param _override_hook_target: Private parameter - set the branch to be
 
 
1712
            supplied as the target_branch to pull hooks.
 
 
1714
        result = PullResult()
 
 
1715
        result.source_branch = source
 
 
1716
        if _override_hook_target is None:
 
 
1717
            result.target_branch = self
 
 
1719
            result.target_branch = _override_hook_target
 
 
1722
            # We assume that during 'pull' the local repository is closer than
 
 
1724
            graph = self.repository.get_graph(source.repository)
 
 
1725
            result.old_revno, result.old_revid = self.last_revision_info()
 
 
1726
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
 
1728
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
 
1729
            result.new_revno, result.new_revid = self.last_revision_info()
 
 
1731
                result.master_branch = _hook_master
 
 
1732
                result.local_branch = result.target_branch
 
 
1734
                result.master_branch = result.target_branch
 
 
1735
                result.local_branch = None
 
 
1737
                for hook in Branch.hooks['post_pull']:
 
 
1743
    def _get_parent_location(self):
 
 
1744
        _locs = ['parent', 'pull', 'x-pull']
 
 
1747
                return self._transport.get_bytes(l).strip('\n')
 
 
1748
            except errors.NoSuchFile:
 
 
1753
    def push(self, target, overwrite=False, stop_revision=None,
 
 
1754
             _override_hook_source_branch=None):
 
 
1757
        This is the basic concrete implementation of push()
 
 
1759
        :param _override_hook_source_branch: If specified, run
 
 
1760
        the hooks passing this Branch as the source, rather than self.  
 
 
1761
        This is for use of RemoteBranch, where push is delegated to the
 
 
1762
        underlying vfs-based Branch. 
 
 
1764
        # TODO: Public option to disable running hooks - should be trivial but
 
 
1766
        return _run_with_write_locked_target(
 
 
1767
            target, self._push_with_bound_branches, target, overwrite,
 
 
1769
            _override_hook_source_branch=_override_hook_source_branch)
 
 
1771
    def _push_with_bound_branches(self, target, overwrite,
 
 
1773
            _override_hook_source_branch=None):
 
 
1774
        """Push from self into target, and into target's master if any.
 
 
1776
        This is on the base BzrBranch class even though it doesn't support 
 
 
1777
        bound branches because the *target* might be bound.
 
 
1780
            if _override_hook_source_branch:
 
 
1781
                result.source_branch = _override_hook_source_branch
 
 
1782
            for hook in Branch.hooks['post_push']:
 
 
1785
        bound_location = target.get_bound_location()
 
 
1786
        if bound_location and target.base != bound_location:
 
 
1787
            # there is a master branch.
 
 
1789
            # XXX: Why the second check?  Is it even supported for a branch to
 
 
1790
            # be bound to itself? -- mbp 20070507
 
 
1791
            master_branch = target.get_master_branch()
 
 
1792
            master_branch.lock_write()
 
 
1794
                # push into the master from this branch.
 
 
1795
                self._basic_push(master_branch, overwrite, stop_revision)
 
 
1796
                # and push into the target branch from this. Note that we push from
 
 
1797
                # this branch again, because its considered the highest bandwidth
 
 
1799
                result = self._basic_push(target, overwrite, stop_revision)
 
 
1800
                result.master_branch = master_branch
 
 
1801
                result.local_branch = target
 
 
1805
                master_branch.unlock()
 
 
1808
            result = self._basic_push(target, overwrite, stop_revision)
 
 
1809
            # TODO: Why set master_branch and local_branch if there's no
 
 
1810
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
 
1812
            result.master_branch = target
 
 
1813
            result.local_branch = None
 
 
1817
    def _basic_push(self, target, overwrite, stop_revision):
 
 
1818
        """Basic implementation of push without bound branches or hooks.
 
 
1820
        Must be called with self read locked and target write locked.
 
 
1822
        result = PushResult()
 
 
1823
        result.source_branch = self
 
 
1824
        result.target_branch = target
 
 
1825
        result.old_revno, result.old_revid = target.last_revision_info()
 
 
1826
        if result.old_revid != self.last_revision():
 
 
1827
            # We assume that during 'push' this repository is closer than
 
 
1829
            graph = self.repository.get_graph(target.repository)
 
 
1830
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
 
1832
        if self._push_should_merge_tags():
 
 
1833
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
 
1834
        result.new_revno, result.new_revid = target.last_revision_info()
 
 
1837
    def _push_should_merge_tags(self):
 
 
1838
        """Should _basic_push merge this branch's tags into the target?
 
 
1840
        The default implementation returns False if this branch has no tags,
 
 
1841
        and True the rest of the time.  Subclasses may override this.
 
 
1843
        return self.tags.supports_tags() and self.tags.get_tag_dict()
 
 
1845
    def get_parent(self):
 
 
1846
        """See Branch.get_parent."""
 
 
1847
        parent = self._get_parent_location()
 
 
1850
        # This is an old-format absolute path to a local branch
 
 
1851
        # turn it into a url
 
 
1852
        if parent.startswith('/'):
 
 
1853
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
 
1855
            return urlutils.join(self.base[:-1], parent)
 
 
1856
        except errors.InvalidURLJoin, e:
 
 
1857
            raise errors.InaccessibleParent(parent, self.base)
 
 
1859
    def get_stacked_on_url(self):
 
 
1860
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
 
1862
    def set_push_location(self, location):
 
 
1863
        """See Branch.set_push_location."""
 
 
1864
        self.get_config().set_user_option(
 
 
1865
            'push_location', location,
 
 
1866
            store=_mod_config.STORE_LOCATION_NORECURSE)
 
 
1869
    def set_parent(self, url):
 
 
1870
        """See Branch.set_parent."""
 
 
1871
        # TODO: Maybe delete old location files?
 
 
1872
        # URLs should never be unicode, even on the local fs,
 
 
1873
        # FIXUP this and get_parent in a future branch format bump:
 
 
1874
        # read and rewrite the file. RBC 20060125
 
 
1876
            if isinstance(url, unicode):
 
 
1878
                    url = url.encode('ascii')
 
 
1879
                except UnicodeEncodeError:
 
 
1880
                    raise errors.InvalidURL(url,
 
 
1881
                        "Urls must be 7-bit ascii, "
 
 
1882
                        "use bzrlib.urlutils.escape")
 
 
1883
            url = urlutils.relative_url(self.base, url)
 
 
1884
        self._set_parent_location(url)
 
 
1886
    def _set_parent_location(self, url):
 
 
1888
            self._transport.delete('parent')
 
 
1890
            self._transport.put_bytes('parent', url + '\n',
 
 
1891
                mode=self.bzrdir._get_file_mode())
 
 
1893
    def set_stacked_on_url(self, url):
 
 
1894
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
 
1897
class BzrBranch5(BzrBranch):
 
 
1898
    """A format 5 branch. This supports new features over plain branches.
 
 
1900
    It has support for a master_branch which is the data for bound branches.
 
 
1904
    def pull(self, source, overwrite=False, stop_revision=None,
 
 
1905
             run_hooks=True, possible_transports=None,
 
 
1906
             _override_hook_target=None):
 
 
1907
        """Pull from source into self, updating my master if any.
 
 
1909
        :param run_hooks: Private parameter - if false, this branch
 
 
1910
            is being called because it's the master of the primary branch,
 
 
1911
            so it should not run its hooks.
 
 
1913
        bound_location = self.get_bound_location()
 
 
1914
        master_branch = None
 
 
1915
        if bound_location and source.base != bound_location:
 
 
1916
            # not pulling from master, so we need to update master.
 
 
1917
            master_branch = self.get_master_branch(possible_transports)
 
 
1918
            master_branch.lock_write()
 
 
1921
                # pull from source into master.
 
 
1922
                master_branch.pull(source, overwrite, stop_revision,
 
 
1924
            return super(BzrBranch5, self).pull(source, overwrite,
 
 
1925
                stop_revision, _hook_master=master_branch,
 
 
1926
                run_hooks=run_hooks,
 
 
1927
                _override_hook_target=_override_hook_target)
 
 
1930
                master_branch.unlock()
 
 
1932
    def get_bound_location(self):
 
 
1934
            return self._transport.get_bytes('bound')[:-1]
 
 
1935
        except errors.NoSuchFile:
 
 
1939
    def get_master_branch(self, possible_transports=None):
 
 
1940
        """Return the branch we are bound to.
 
 
1942
        :return: Either a Branch, or None
 
 
1944
        This could memoise the branch, but if thats done
 
 
1945
        it must be revalidated on each new lock.
 
 
1946
        So for now we just don't memoise it.
 
 
1947
        # RBC 20060304 review this decision.
 
 
1949
        bound_loc = self.get_bound_location()
 
 
1953
            return Branch.open(bound_loc,
 
 
1954
                               possible_transports=possible_transports)
 
 
1955
        except (errors.NotBranchError, errors.ConnectionError), e:
 
 
1956
            raise errors.BoundBranchConnectionFailure(
 
 
1960
    def set_bound_location(self, location):
 
 
1961
        """Set the target where this branch is bound to.
 
 
1963
        :param location: URL to the target branch
 
 
1966
            self._transport.put_bytes('bound', location+'\n',
 
 
1967
                mode=self.bzrdir._get_file_mode())
 
 
1970
                self._transport.delete('bound')
 
 
1971
            except errors.NoSuchFile:
 
 
1976
    def bind(self, other):
 
 
1977
        """Bind this branch to the branch other.
 
 
1979
        This does not push or pull data between the branches, though it does
 
 
1980
        check for divergence to raise an error when the branches are not
 
 
1981
        either the same, or one a prefix of the other. That behaviour may not
 
 
1982
        be useful, so that check may be removed in future.
 
 
1984
        :param other: The branch to bind to
 
 
1987
        # TODO: jam 20051230 Consider checking if the target is bound
 
 
1988
        #       It is debatable whether you should be able to bind to
 
 
1989
        #       a branch which is itself bound.
 
 
1990
        #       Committing is obviously forbidden,
 
 
1991
        #       but binding itself may not be.
 
 
1992
        #       Since we *have* to check at commit time, we don't
 
 
1993
        #       *need* to check here
 
 
1995
        # we want to raise diverged if:
 
 
1996
        # last_rev is not in the other_last_rev history, AND
 
 
1997
        # other_last_rev is not in our history, and do it without pulling
 
 
1999
        self.set_bound_location(other.base)
 
 
2003
        """If bound, unbind"""
 
 
2004
        return self.set_bound_location(None)
 
 
2007
    def update(self, possible_transports=None):
 
 
2008
        """Synchronise this branch with the master branch if any. 
 
 
2010
        :return: None or the last_revision that was pivoted out during the
 
 
2013
        master = self.get_master_branch(possible_transports)
 
 
2014
        if master is not None:
 
 
2015
            old_tip = _mod_revision.ensure_null(self.last_revision())
 
 
2016
            self.pull(master, overwrite=True)
 
 
2017
            if self.repository.get_graph().is_ancestor(old_tip,
 
 
2018
                _mod_revision.ensure_null(self.last_revision())):
 
 
2024
class BzrBranch7(BzrBranch5):
 
 
2025
    """A branch with support for a fallback repository."""
 
 
2027
    def _get_fallback_repository(self, url):
 
 
2028
        """Get the repository we fallback to at url."""
 
 
2029
        url = urlutils.join(self.base, url)
 
 
2030
        return bzrdir.BzrDir.open(url).open_branch().repository
 
 
2032
    def _activate_fallback_location(self, url):
 
 
2033
        """Activate the branch/repository from url as a fallback repository."""
 
 
2034
        self.repository.add_fallback_repository(
 
 
2035
            self._get_fallback_repository(url))
 
 
2037
    def _open_hook(self):
 
 
2039
            url = self.get_stacked_on_url()
 
 
2040
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
 
 
2041
            errors.UnstackableBranchFormat):
 
 
2044
            for hook in Branch.hooks['transform_fallback_location']:
 
 
2045
                url = hook(self, url)
 
 
2047
                    hook_name = Branch.hooks.get_hook_name(hook)
 
 
2048
                    raise AssertionError(
 
 
2049
                        "'transform_fallback_location' hook %s returned "
 
 
2050
                        "None, not a URL." % hook_name)
 
 
2051
            self._activate_fallback_location(url)
 
 
2053
    def _check_stackable_repo(self):
 
 
2054
        if not self.repository._format.supports_external_lookups:
 
 
2055
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
 
2056
                self.repository.base)
 
 
2058
    def __init__(self, *args, **kwargs):
 
 
2059
        super(BzrBranch7, self).__init__(*args, **kwargs)
 
 
2060
        self._last_revision_info_cache = None
 
 
2061
        self._partial_revision_history_cache = []
 
 
2063
    def _clear_cached_state(self):
 
 
2064
        super(BzrBranch7, self)._clear_cached_state()
 
 
2065
        self._last_revision_info_cache = None
 
 
2066
        self._partial_revision_history_cache = []
 
 
2068
    def _last_revision_info(self):
 
 
2069
        revision_string = self._transport.get_bytes('last-revision')
 
 
2070
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
 
2071
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
 
2073
        return revno, revision_id
 
 
2075
    def _write_last_revision_info(self, revno, revision_id):
 
 
2076
        """Simply write out the revision id, with no checks.
 
 
2078
        Use set_last_revision_info to perform this safely.
 
 
2080
        Does not update the revision_history cache.
 
 
2081
        Intended to be called by set_last_revision_info and
 
 
2082
        _write_revision_history.
 
 
2084
        revision_id = _mod_revision.ensure_null(revision_id)
 
 
2085
        out_string = '%d %s\n' % (revno, revision_id)
 
 
2086
        self._transport.put_bytes('last-revision', out_string,
 
 
2087
            mode=self.bzrdir._get_file_mode())
 
 
2090
    def set_last_revision_info(self, revno, revision_id):
 
 
2091
        revision_id = _mod_revision.ensure_null(revision_id)
 
 
2092
        old_revno, old_revid = self.last_revision_info()
 
 
2093
        if self._get_append_revisions_only():
 
 
2094
            self._check_history_violation(revision_id)
 
 
2095
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
 
2096
        self._write_last_revision_info(revno, revision_id)
 
 
2097
        self._clear_cached_state()
 
 
2098
        self._last_revision_info_cache = revno, revision_id
 
 
2099
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
 
2101
    def _check_history_violation(self, revision_id):
 
 
2102
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
 
2103
        if _mod_revision.is_null(last_revision):
 
 
2105
        if last_revision not in self._lefthand_history(revision_id):
 
 
2106
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
 
2108
    def _gen_revision_history(self):
 
 
2109
        """Generate the revision history from last revision
 
 
2111
        last_revno, last_revision = self.last_revision_info()
 
 
2112
        self._extend_partial_history(stop_index=last_revno-1)
 
 
2113
        return list(reversed(self._partial_revision_history_cache))
 
 
2115
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
 
2116
        """Extend the partial history to include a given index
 
 
2118
        If a stop_index is supplied, stop when that index has been reached.
 
 
2119
        If a stop_revision is supplied, stop when that revision is
 
 
2120
        encountered.  Otherwise, stop when the beginning of history is
 
 
2123
        :param stop_index: The index which should be present.  When it is
 
 
2124
            present, history extension will stop.
 
 
2125
        :param revision_id: The revision id which should be present.  When
 
 
2126
            it is encountered, history extension will stop.
 
 
2128
        repo = self.repository
 
 
2129
        if len(self._partial_revision_history_cache) == 0:
 
 
2130
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
 
2132
            start_revision = self._partial_revision_history_cache[-1]
 
 
2133
            iterator = repo.iter_reverse_revision_history(start_revision)
 
 
2134
            #skip the last revision in the list
 
 
2135
            next_revision = iterator.next()
 
 
2136
        for revision_id in iterator:
 
 
2137
            self._partial_revision_history_cache.append(revision_id)
 
 
2138
            if (stop_index is not None and
 
 
2139
                len(self._partial_revision_history_cache) > stop_index):
 
 
2141
            if revision_id == stop_revision:
 
 
2144
    def _write_revision_history(self, history):
 
 
2145
        """Factored out of set_revision_history.
 
 
2147
        This performs the actual writing to disk, with format-specific checks.
 
 
2148
        It is intended to be called by BzrBranch5.set_revision_history.
 
 
2150
        if len(history) == 0:
 
 
2151
            last_revision = 'null:'
 
 
2153
            if history != self._lefthand_history(history[-1]):
 
 
2154
                raise errors.NotLefthandHistory(history)
 
 
2155
            last_revision = history[-1]
 
 
2156
        if self._get_append_revisions_only():
 
 
2157
            self._check_history_violation(last_revision)
 
 
2158
        self._write_last_revision_info(len(history), last_revision)
 
 
2161
    def _set_parent_location(self, url):
 
 
2162
        """Set the parent branch"""
 
 
2163
        self._set_config_location('parent_location', url, make_relative=True)
 
 
2166
    def _get_parent_location(self):
 
 
2167
        """Set the parent branch"""
 
 
2168
        return self._get_config_location('parent_location')
 
 
2170
    def set_push_location(self, location):
 
 
2171
        """See Branch.set_push_location."""
 
 
2172
        self._set_config_location('push_location', location)
 
 
2174
    def set_bound_location(self, location):
 
 
2175
        """See Branch.set_push_location."""
 
 
2177
        config = self.get_config()
 
 
2178
        if location is None:
 
 
2179
            if config.get_user_option('bound') != 'True':
 
 
2182
                config.set_user_option('bound', 'False', warn_masked=True)
 
 
2185
            self._set_config_location('bound_location', location,
 
 
2187
            config.set_user_option('bound', 'True', warn_masked=True)
 
 
2190
    def _get_bound_location(self, bound):
 
 
2191
        """Return the bound location in the config file.
 
 
2193
        Return None if the bound parameter does not match"""
 
 
2194
        config = self.get_config()
 
 
2195
        config_bound = (config.get_user_option('bound') == 'True')
 
 
2196
        if config_bound != bound:
 
 
2198
        return self._get_config_location('bound_location', config=config)
 
 
2200
    def get_bound_location(self):
 
 
2201
        """See Branch.set_push_location."""
 
 
2202
        return self._get_bound_location(True)
 
 
2204
    def get_old_bound_location(self):
 
 
2205
        """See Branch.get_old_bound_location"""
 
 
2206
        return self._get_bound_location(False)
 
 
2208
    def get_stacked_on_url(self):
 
 
2209
        # you can always ask for the URL; but you might not be able to use it
 
 
2210
        # if the repo can't support stacking.
 
 
2211
        ## self._check_stackable_repo()
 
 
2212
        stacked_url = self._get_config_location('stacked_on_location')
 
 
2213
        if stacked_url is None:
 
 
2214
            raise errors.NotStacked(self)
 
 
2217
    def set_append_revisions_only(self, enabled):
 
 
2222
        self.get_config().set_user_option('append_revisions_only', value,
 
 
2225
    def set_stacked_on_url(self, url):
 
 
2226
        self._check_stackable_repo()
 
 
2229
                old_url = self.get_stacked_on_url()
 
 
2230
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
 
2231
                errors.UnstackableRepositoryFormat):
 
 
2234
            # repositories don't offer an interface to remove fallback
 
 
2235
            # repositories today; take the conceptually simpler option and just
 
 
2237
            self.repository = self.bzrdir.find_repository()
 
 
2238
            # for every revision reference the branch has, ensure it is pulled
 
 
2240
            source_repository = self._get_fallback_repository(old_url)
 
 
2241
            for revision_id in chain([self.last_revision()],
 
 
2242
                self.tags.get_reverse_tag_dict()):
 
 
2243
                self.repository.fetch(source_repository, revision_id,
 
 
2246
            self._activate_fallback_location(url)
 
 
2247
        # write this out after the repository is stacked to avoid setting a
 
 
2248
        # stacked config that doesn't work.
 
 
2249
        self._set_config_location('stacked_on_location', url)
 
 
2251
    def _get_append_revisions_only(self):
 
 
2252
        value = self.get_config().get_user_option('append_revisions_only')
 
 
2253
        return value == 'True'
 
 
2255
    def _synchronize_history(self, destination, revision_id):
 
 
2256
        """Synchronize last revision and revision history between branches.
 
 
2258
        This version is most efficient when the destination is also a
 
 
2259
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
 
2260
        repository contains all the lefthand ancestors of the intended
 
 
2261
        last_revision.  If not, set_last_revision_info will fail.
 
 
2263
        :param destination: The branch to copy the history into
 
 
2264
        :param revision_id: The revision-id to truncate history at.  May
 
 
2265
          be None to copy complete history.
 
 
2267
        source_revno, source_revision_id = self.last_revision_info()
 
 
2268
        if revision_id is None:
 
 
2269
            revno, revision_id = source_revno, source_revision_id
 
 
2270
        elif source_revision_id == revision_id:
 
 
2271
            # we know the revno without needing to walk all of history
 
 
2272
            revno = source_revno
 
 
2274
            # To figure out the revno for a random revision, we need to build
 
 
2275
            # the revision history, and count its length.
 
 
2276
            # We don't care about the order, just how long it is.
 
 
2277
            # Alternatively, we could start at the current location, and count
 
 
2278
            # backwards. But there is no guarantee that we will find it since
 
 
2279
            # it may be a merged revision.
 
 
2280
            revno = len(list(self.repository.iter_reverse_revision_history(
 
 
2282
        destination.set_last_revision_info(revno, revision_id)
 
 
2284
    def _make_tags(self):
 
 
2285
        return BasicTags(self)
 
 
2288
    def generate_revision_history(self, revision_id, last_rev=None,
 
 
2290
        """See BzrBranch5.generate_revision_history"""
 
 
2291
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
 
2292
        revno = len(history)
 
 
2293
        self.set_last_revision_info(revno, revision_id)
 
 
2296
    def get_rev_id(self, revno, history=None):
 
 
2297
        """Find the revision id of the specified revno."""
 
 
2299
            return _mod_revision.NULL_REVISION
 
 
2301
        last_revno, last_revision_id = self.last_revision_info()
 
 
2302
        if revno <= 0 or revno > last_revno:
 
 
2303
            raise errors.NoSuchRevision(self, revno)
 
 
2305
        if history is not None:
 
 
2306
            return history[revno - 1]
 
 
2308
        index = last_revno - revno
 
 
2309
        if len(self._partial_revision_history_cache) <= index:
 
 
2310
            self._extend_partial_history(stop_index=index)
 
 
2311
        if len(self._partial_revision_history_cache) > index:
 
 
2312
            return self._partial_revision_history_cache[index]
 
 
2314
            raise errors.NoSuchRevision(self, revno)
 
 
2317
    def revision_id_to_revno(self, revision_id):
 
 
2318
        """Given a revision id, return its revno"""
 
 
2319
        if _mod_revision.is_null(revision_id):
 
 
2322
            index = self._partial_revision_history_cache.index(revision_id)
 
 
2324
            self._extend_partial_history(stop_revision=revision_id)
 
 
2325
            index = len(self._partial_revision_history_cache) - 1
 
 
2326
            if self._partial_revision_history_cache[index] != revision_id:
 
 
2327
                raise errors.NoSuchRevision(self, revision_id)
 
 
2328
        return self.revno() - index
 
 
2331
class BzrBranch6(BzrBranch7):
 
 
2332
    """See BzrBranchFormat6 for the capabilities of this branch.
 
 
2334
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
 
 
2338
    def get_stacked_on_url(self):
 
 
2339
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
 
2341
    def set_stacked_on_url(self, url):
 
 
2342
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
 
2345
######################################################################
 
 
2346
# results of operations
 
 
2349
class _Result(object):
 
 
2351
    def _show_tag_conficts(self, to_file):
 
 
2352
        if not getattr(self, 'tag_conflicts', None):
 
 
2354
        to_file.write('Conflicting tags:\n')
 
 
2355
        for name, value1, value2 in self.tag_conflicts:
 
 
2356
            to_file.write('    %s\n' % (name, ))
 
 
2359
class PullResult(_Result):
 
 
2360
    """Result of a Branch.pull operation.
 
 
2362
    :ivar old_revno: Revision number before pull.
 
 
2363
    :ivar new_revno: Revision number after pull.
 
 
2364
    :ivar old_revid: Tip revision id before pull.
 
 
2365
    :ivar new_revid: Tip revision id after pull.
 
 
2366
    :ivar source_branch: Source (local) branch object.
 
 
2367
    :ivar master_branch: Master branch of the target, or the target if no
 
 
2369
    :ivar local_branch: target branch if there is a Master, else None
 
 
2370
    :ivar target_branch: Target/destination branch object.
 
 
2371
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
 
2375
        # DEPRECATED: pull used to return the change in revno
 
 
2376
        return self.new_revno - self.old_revno
 
 
2378
    def report(self, to_file):
 
 
2380
            if self.old_revid == self.new_revid:
 
 
2381
                to_file.write('No revisions to pull.\n')
 
 
2383
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
 
2384
        self._show_tag_conficts(to_file)
 
 
2387
class PushResult(_Result):
 
 
2388
    """Result of a Branch.push operation.
 
 
2390
    :ivar old_revno: Revision number before push.
 
 
2391
    :ivar new_revno: Revision number after push.
 
 
2392
    :ivar old_revid: Tip revision id before push.
 
 
2393
    :ivar new_revid: Tip revision id after push.
 
 
2394
    :ivar source_branch: Source branch object.
 
 
2395
    :ivar master_branch: Master branch of the target, or None.
 
 
2396
    :ivar target_branch: Target/destination branch object.
 
 
2400
        # DEPRECATED: push used to return the change in revno
 
 
2401
        return self.new_revno - self.old_revno
 
 
2403
    def report(self, to_file):
 
 
2404
        """Write a human-readable description of the result."""
 
 
2405
        if self.old_revid == self.new_revid:
 
 
2406
            to_file.write('No new revisions to push.\n')
 
 
2408
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
 
 
2409
        self._show_tag_conficts(to_file)
 
 
2412
class BranchCheckResult(object):
 
 
2413
    """Results of checking branch consistency.
 
 
2418
    def __init__(self, branch):
 
 
2419
        self.branch = branch
 
 
2421
    def report_results(self, verbose):
 
 
2422
        """Report the check results via trace.note.
 
 
2424
        :param verbose: Requests more detailed display of what was checked,
 
 
2427
        note('checked branch %s format %s',
 
 
2429
             self.branch._format)
 
 
2432
class Converter5to6(object):
 
 
2433
    """Perform an in-place upgrade of format 5 to format 6"""
 
 
2435
    def convert(self, branch):
 
 
2436
        # Data for 5 and 6 can peacefully coexist.
 
 
2437
        format = BzrBranchFormat6()
 
 
2438
        new_branch = format.open(branch.bzrdir, _found=True)
 
 
2440
        # Copy source data into target
 
 
2441
        new_branch._write_last_revision_info(*branch.last_revision_info())
 
 
2442
        new_branch.set_parent(branch.get_parent())
 
 
2443
        new_branch.set_bound_location(branch.get_bound_location())
 
 
2444
        new_branch.set_push_location(branch.get_push_location())
 
 
2446
        # New branch has no tags by default
 
 
2447
        new_branch.tags._set_tag_dict({})
 
 
2449
        # Copying done; now update target format
 
 
2450
        new_branch._transport.put_bytes('format',
 
 
2451
            format.get_format_string(),
 
 
2452
            mode=new_branch.bzrdir._get_file_mode())
 
 
2454
        # Clean up old files
 
 
2455
        new_branch._transport.delete('revision-history')
 
 
2457
            branch.set_parent(None)
 
 
2458
        except errors.NoSuchFile:
 
 
2460
        branch.set_bound_location(None)
 
 
2463
class Converter6to7(object):
 
 
2464
    """Perform an in-place upgrade of format 6 to format 7"""
 
 
2466
    def convert(self, branch):
 
 
2467
        format = BzrBranchFormat7()
 
 
2468
        branch._set_config_location('stacked_on_location', '')
 
 
2469
        # update target format
 
 
2470
        branch._transport.put_bytes('format', format.get_format_string())
 
 
2474
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
 
2475
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
 
2478
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
 
2480
    If an exception is raised by callable, then that exception *will* be
 
 
2481
    propagated, even if the unlock attempt raises its own error.  Thus
 
 
2482
    _run_with_write_locked_target should be preferred to simply doing::
 
 
2486
            return callable(*args, **kwargs)
 
 
2491
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
 
2492
    # should share code?
 
 
2495
        result = callable(*args, **kwargs)
 
 
2497
        exc_info = sys.exc_info()
 
 
2501
            raise exc_info[0], exc_info[1], exc_info[2]