~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-05-19 06:14:38 UTC
  • mfrom: (1704.2.23 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060519061438-6300caf3926c3cff
(mbp) small fixes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
from copy import deepcopy
18
19
from cStringIO import StringIO
 
20
import errno
 
21
import os
 
22
import shutil
19
23
import sys
20
 
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
from itertools import chain
24
 
from bzrlib import (
25
 
        bzrdir,
26
 
        cache_utf8,
27
 
        config as _mod_config,
28
 
        debug,
29
 
        errors,
30
 
        lockdir,
31
 
        lockable_files,
32
 
        repository,
33
 
        revision as _mod_revision,
34
 
        rio,
35
 
        symbol_versioning,
36
 
        transport,
37
 
        tsort,
38
 
        ui,
39
 
        urlutils,
40
 
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
 
from bzrlib.tag import (
44
 
    BasicTags,
45
 
    DisabledTags,
46
 
    )
47
 
""")
48
 
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
51
 
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
 
from bzrlib import registry
54
 
from bzrlib.symbol_versioning import (
55
 
    deprecated_in,
56
 
    deprecated_method,
57
 
    )
58
 
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
 
24
from unittest import TestSuite
 
25
from warnings import warn
 
26
 
 
27
import bzrlib
 
28
import bzrlib.bzrdir as bzrdir
 
29
from bzrlib.config import TreeConfig
 
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
31
from bzrlib.delta import compare_trees
 
32
import bzrlib.errors as errors
 
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
34
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
35
                           DivergedBranches, LockError,
 
36
                           UninitializableFormat,
 
37
                           UnlistableStore,
 
38
                           UnlistableBranch, NoSuchFile, NotVersionedError,
 
39
                           NoWorkingTree)
 
40
import bzrlib.inventory as inventory
 
41
from bzrlib.inventory import Inventory
 
42
from bzrlib.lockable_files import LockableFiles, TransportLock
 
43
from bzrlib.lockdir import LockDir
 
44
from bzrlib.osutils import (isdir, quotefn,
 
45
                            rename, splitpath, sha_file,
 
46
                            file_kind, abspath, normpath, pathjoin,
 
47
                            safe_unicode,
 
48
                            rmtree,
 
49
                            )
 
50
from bzrlib.textui import show_status
 
51
from bzrlib.trace import mutter, note
 
52
from bzrlib.tree import EmptyTree, RevisionTree
 
53
from bzrlib.repository import Repository
 
54
from bzrlib.revision import (
 
55
                             is_ancestor,
 
56
                             NULL_REVISION,
 
57
                             Revision,
 
58
                             )
 
59
from bzrlib.store import copy_all
 
60
from bzrlib.symbol_versioning import *
 
61
import bzrlib.transactions as transactions
 
62
from bzrlib.transport import Transport, get_transport
 
63
from bzrlib.tree import EmptyTree, RevisionTree
 
64
import bzrlib.ui
 
65
import bzrlib.xml5
59
66
 
60
67
 
61
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
64
71
 
65
72
 
66
73
# TODO: Maybe include checks for common corruption of newlines, etc?
80
87
 
81
88
    base
82
89
        Base directory/url of the branch.
83
 
 
84
 
    hooks: An instance of BranchHooks.
85
90
    """
86
91
    # this is really an instance variable - FIXME move it there
87
92
    # - RBC 20060112
88
93
    base = None
89
94
 
90
95
    def __init__(self, *ignored, **ignored_too):
91
 
        self.tags = self._format.make_tags(self)
92
 
        self._revision_history_cache = None
93
 
        self._revision_id_to_revno_cache = None
94
 
        self._partial_revision_id_to_revno_cache = {}
95
 
        self._partial_revision_history_cache = []
96
 
        self._last_revision_info_cache = None
97
 
        self._merge_sorted_revisions_cache = None
98
 
        self._open_hook()
99
 
        hooks = Branch.hooks['open']
100
 
        for hook in hooks:
101
 
            hook(self)
102
 
 
103
 
    def _open_hook(self):
104
 
        """Called by init to allow simpler extension of the base class."""
105
 
 
106
 
    def _activate_fallback_location(self, url):
107
 
        """Activate the branch/repository from url as a fallback repository."""
108
 
        repo = self._get_fallback_repository(url)
109
 
        if repo.has_same_location(self.repository):
110
 
            raise errors.UnstackableLocationError(self.base, url)
111
 
        self.repository.add_fallback_repository(repo)
 
96
        raise NotImplementedError('The Branch class is abstract')
112
97
 
113
98
    def break_lock(self):
114
99
        """Break a lock if one is present from another instance.
124
109
        if master is not None:
125
110
            master.break_lock()
126
111
 
127
 
    def _check_stackable_repo(self):
128
 
        if not self.repository._format.supports_external_lookups:
129
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
130
 
                self.repository.base)
131
 
 
132
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
 
        """Extend the partial history to include a given index
134
 
 
135
 
        If a stop_index is supplied, stop when that index has been reached.
136
 
        If a stop_revision is supplied, stop when that revision is
137
 
        encountered.  Otherwise, stop when the beginning of history is
138
 
        reached.
139
 
 
140
 
        :param stop_index: The index which should be present.  When it is
141
 
            present, history extension will stop.
142
 
        :param stop_revision: The revision id which should be present.  When
143
 
            it is encountered, history extension will stop.
144
 
        """
145
 
        if len(self._partial_revision_history_cache) == 0:
146
 
            self._partial_revision_history_cache = [self.last_revision()]
147
 
        repository._iter_for_revno(
148
 
            self.repository, self._partial_revision_history_cache,
149
 
            stop_index=stop_index, stop_revision=stop_revision)
150
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
 
            self._partial_revision_history_cache.pop()
152
 
 
153
 
    def _get_check_refs(self):
154
 
        """Get the references needed for check().
155
 
 
156
 
        See bzrlib.check.
157
 
        """
158
 
        revid = self.last_revision()
159
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
160
 
 
161
 
    @staticmethod
162
 
    def open(base, _unsupported=False, possible_transports=None):
163
 
        """Open the branch rooted at base.
164
 
 
165
 
        For instance, if the branch is at URL/.bzr/branch,
166
 
        Branch.open(URL) -> a Branch instance.
167
 
        """
168
 
        control = bzrdir.BzrDir.open(base, _unsupported,
169
 
                                     possible_transports=possible_transports)
170
 
        return control.open_branch(_unsupported)
171
 
 
172
 
    @staticmethod
173
 
    def open_from_transport(transport, _unsupported=False):
174
 
        """Open the branch rooted at transport"""
175
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
 
        return control.open_branch(_unsupported)
177
 
 
178
 
    @staticmethod
179
 
    def open_containing(url, possible_transports=None):
 
112
    @staticmethod
 
113
    @deprecated_method(zero_eight)
 
114
    def open_downlevel(base):
 
115
        """Open a branch which may be of an old format."""
 
116
        return Branch.open(base, _unsupported=True)
 
117
        
 
118
    @staticmethod
 
119
    def open(base, _unsupported=False):
 
120
        """Open the repository rooted at base.
 
121
 
 
122
        For instance, if the repository is at URL/.bzr/repository,
 
123
        Repository.open(URL) -> a Repository instance.
 
124
        """
 
125
        control = bzrdir.BzrDir.open(base, _unsupported)
 
126
        return control.open_branch(_unsupported)
 
127
 
 
128
    @staticmethod
 
129
    def open_containing(url):
180
130
        """Open an existing branch which contains url.
181
 
 
 
131
        
182
132
        This probes for a branch at url, and searches upwards from there.
183
133
 
184
134
        Basically we keep looking up until we find the control directory or
185
135
        run into the root.  If there isn't one, raises NotBranchError.
186
 
        If there is one and it is either an unrecognised format or an unsupported
 
136
        If there is one and it is either an unrecognised format or an unsupported 
187
137
        format, UnknownFormatError or UnsupportedFormatError are raised.
188
138
        If there is one, it is returned, along with the unused portion of url.
189
139
        """
190
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
191
 
                                                         possible_transports)
 
140
        control, relpath = bzrdir.BzrDir.open_containing(url)
192
141
        return control.open_branch(), relpath
193
142
 
194
 
    def _push_should_merge_tags(self):
195
 
        """Should _basic_push merge this branch's tags into the target?
196
 
 
197
 
        The default implementation returns False if this branch has no tags,
198
 
        and True the rest of the time.  Subclasses may override this.
199
 
        """
200
 
        return self.supports_tags() and self.tags.get_tag_dict()
201
 
 
202
 
    def get_config(self):
203
 
        return BranchConfig(self)
204
 
 
205
 
    def _get_config(self):
206
 
        """Get the concrete config for just the config in this branch.
207
 
 
208
 
        This is not intended for client use; see Branch.get_config for the
209
 
        public API.
210
 
 
211
 
        Added in 1.14.
212
 
 
213
 
        :return: An object supporting get_option and set_option.
214
 
        """
215
 
        raise NotImplementedError(self._get_config)
216
 
 
217
 
    def _get_fallback_repository(self, url):
218
 
        """Get the repository we fallback to at url."""
219
 
        url = urlutils.join(self.base, url)
220
 
        a_bzrdir = bzrdir.BzrDir.open(url,
221
 
            possible_transports=[self.bzrdir.root_transport])
222
 
        return a_bzrdir.open_branch().repository
223
 
 
224
 
    def _get_tags_bytes(self):
225
 
        """Get the bytes of a serialised tags dict.
226
 
 
227
 
        Note that not all branches support tags, nor do all use the same tags
228
 
        logic: this method is specific to BasicTags. Other tag implementations
229
 
        may use the same method name and behave differently, safely, because
230
 
        of the double-dispatch via
231
 
        format.make_tags->tags_instance->get_tags_dict.
232
 
 
233
 
        :return: The bytes of the tags file.
234
 
        :seealso: Branch._set_tags_bytes.
235
 
        """
236
 
        return self._transport.get_bytes('tags')
237
 
 
238
 
    def _get_nick(self, local=False, possible_transports=None):
239
 
        config = self.get_config()
240
 
        # explicit overrides master, but don't look for master if local is True
241
 
        if not local and not config.has_explicit_nickname():
242
 
            try:
243
 
                master = self.get_master_branch(possible_transports)
244
 
                if master is not None:
245
 
                    # return the master branch value
246
 
                    return master.nick
247
 
            except errors.BzrError, e:
248
 
                # Silently fall back to local implicit nick if the master is
249
 
                # unavailable
250
 
                mutter("Could not connect to bound branch, "
251
 
                    "falling back to local nick.\n " + str(e))
252
 
        return config.get_nickname()
 
143
    @staticmethod
 
144
    @deprecated_function(zero_eight)
 
145
    def initialize(base):
 
146
        """Create a new working tree and branch, rooted at 'base' (url)
 
147
 
 
148
        NOTE: This will soon be deprecated in favour of creation
 
149
        through a BzrDir.
 
150
        """
 
151
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
 
152
 
 
153
    def setup_caching(self, cache_root):
 
154
        """Subclasses that care about caching should override this, and set
 
155
        up cached stores located under cache_root.
 
156
        """
 
157
        # seems to be unused, 2006-01-13 mbp
 
158
        warn('%s is deprecated' % self.setup_caching)
 
159
        self.cache_root = cache_root
 
160
 
 
161
    def _get_nick(self):
 
162
        cfg = self.tree_config()
 
163
        return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
253
164
 
254
165
    def _set_nick(self, nick):
255
 
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
 
166
        cfg = self.tree_config()
 
167
        cfg.set_option(nick, "nickname")
 
168
        assert cfg.get_option("nickname") == nick
256
169
 
257
170
    nick = property(_get_nick, _set_nick)
258
171
 
259
172
    def is_locked(self):
260
 
        raise NotImplementedError(self.is_locked)
261
 
 
262
 
    def _lefthand_history(self, revision_id, last_rev=None,
263
 
                          other_branch=None):
264
 
        if 'evil' in debug.debug_flags:
265
 
            mutter_callsite(4, "_lefthand_history scales with history.")
266
 
        # stop_revision must be a descendant of last_revision
267
 
        graph = self.repository.get_graph()
268
 
        if last_rev is not None:
269
 
            if not graph.is_ancestor(last_rev, revision_id):
270
 
                # our previous tip is not merged into stop_revision
271
 
                raise errors.DivergedBranches(self, other_branch)
272
 
        # make a new revision history from the graph
273
 
        parents_map = graph.get_parent_map([revision_id])
274
 
        if revision_id not in parents_map:
275
 
            raise errors.NoSuchRevision(self, revision_id)
276
 
        current_rev_id = revision_id
277
 
        new_history = []
278
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
279
 
        # Do not include ghosts or graph origin in revision_history
280
 
        while (current_rev_id in parents_map and
281
 
               len(parents_map[current_rev_id]) > 0):
282
 
            check_not_reserved_id(current_rev_id)
283
 
            new_history.append(current_rev_id)
284
 
            current_rev_id = parents_map[current_rev_id][0]
285
 
            parents_map = graph.get_parent_map([current_rev_id])
286
 
        new_history.reverse()
287
 
        return new_history
 
173
        raise NotImplementedError('is_locked is abstract')
288
174
 
289
175
    def lock_write(self):
290
 
        raise NotImplementedError(self.lock_write)
 
176
        raise NotImplementedError('lock_write is abstract')
291
177
 
292
178
    def lock_read(self):
293
 
        raise NotImplementedError(self.lock_read)
 
179
        raise NotImplementedError('lock_read is abstract')
294
180
 
295
181
    def unlock(self):
296
 
        raise NotImplementedError(self.unlock)
 
182
        raise NotImplementedError('unlock is abstract')
297
183
 
298
184
    def peek_lock_mode(self):
299
185
        """Return lock mode for the Branch: 'r', 'w' or None"""
300
186
        raise NotImplementedError(self.peek_lock_mode)
301
187
 
302
188
    def get_physical_lock_status(self):
303
 
        raise NotImplementedError(self.get_physical_lock_status)
304
 
 
305
 
    @needs_read_lock
306
 
    def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
 
        """Return the revision_id for a dotted revno.
308
 
 
309
 
        :param revno: a tuple like (1,) or (1,1,2)
310
 
        :param _cache_reverse: a private parameter enabling storage
311
 
           of the reverse mapping in a top level cache. (This should
312
 
           only be done in selective circumstances as we want to
313
 
           avoid having the mapping cached multiple times.)
314
 
        :return: the revision_id
315
 
        :raises errors.NoSuchRevision: if the revno doesn't exist
316
 
        """
317
 
        rev_id = self._do_dotted_revno_to_revision_id(revno)
318
 
        if _cache_reverse:
319
 
            self._partial_revision_id_to_revno_cache[rev_id] = revno
320
 
        return rev_id
321
 
 
322
 
    def _do_dotted_revno_to_revision_id(self, revno):
323
 
        """Worker function for dotted_revno_to_revision_id.
324
 
 
325
 
        Subclasses should override this if they wish to
326
 
        provide a more efficient implementation.
327
 
        """
328
 
        if len(revno) == 1:
329
 
            return self.get_rev_id(revno[0])
330
 
        revision_id_to_revno = self.get_revision_id_to_revno_map()
331
 
        revision_ids = [revision_id for revision_id, this_revno
332
 
                        in revision_id_to_revno.iteritems()
333
 
                        if revno == this_revno]
334
 
        if len(revision_ids) == 1:
335
 
            return revision_ids[0]
336
 
        else:
337
 
            revno_str = '.'.join(map(str, revno))
338
 
            raise errors.NoSuchRevision(self, revno_str)
339
 
 
340
 
    @needs_read_lock
341
 
    def revision_id_to_dotted_revno(self, revision_id):
342
 
        """Given a revision id, return its dotted revno.
343
 
 
344
 
        :return: a tuple like (1,) or (400,1,3).
345
 
        """
346
 
        return self._do_revision_id_to_dotted_revno(revision_id)
347
 
 
348
 
    def _do_revision_id_to_dotted_revno(self, revision_id):
349
 
        """Worker function for revision_id_to_revno."""
350
 
        # Try the caches if they are loaded
351
 
        result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
 
        if result is not None:
353
 
            return result
354
 
        if self._revision_id_to_revno_cache:
355
 
            result = self._revision_id_to_revno_cache.get(revision_id)
356
 
            if result is None:
357
 
                raise errors.NoSuchRevision(self, revision_id)
358
 
        # Try the mainline as it's optimised
359
 
        try:
360
 
            revno = self.revision_id_to_revno(revision_id)
361
 
            return (revno,)
362
 
        except errors.NoSuchRevision:
363
 
            # We need to load and use the full revno map after all
364
 
            result = self.get_revision_id_to_revno_map().get(revision_id)
365
 
            if result is None:
366
 
                raise errors.NoSuchRevision(self, revision_id)
367
 
        return result
368
 
 
369
 
    @needs_read_lock
370
 
    def get_revision_id_to_revno_map(self):
371
 
        """Return the revision_id => dotted revno map.
372
 
 
373
 
        This will be regenerated on demand, but will be cached.
374
 
 
375
 
        :return: A dictionary mapping revision_id => dotted revno.
376
 
            This dictionary should not be modified by the caller.
377
 
        """
378
 
        if self._revision_id_to_revno_cache is not None:
379
 
            mapping = self._revision_id_to_revno_cache
380
 
        else:
381
 
            mapping = self._gen_revno_map()
382
 
            self._cache_revision_id_to_revno(mapping)
383
 
        # TODO: jam 20070417 Since this is being cached, should we be returning
384
 
        #       a copy?
385
 
        # I would rather not, and instead just declare that users should not
386
 
        # modify the return value.
387
 
        return mapping
388
 
 
389
 
    def _gen_revno_map(self):
390
 
        """Create a new mapping from revision ids to dotted revnos.
391
 
 
392
 
        Dotted revnos are generated based on the current tip in the revision
393
 
        history.
394
 
        This is the worker function for get_revision_id_to_revno_map, which
395
 
        just caches the return value.
396
 
 
397
 
        :return: A dictionary mapping revision_id => dotted revno.
398
 
        """
399
 
        revision_id_to_revno = dict((rev_id, revno)
400
 
            for rev_id, depth, revno, end_of_merge
401
 
             in self.iter_merge_sorted_revisions())
402
 
        return revision_id_to_revno
403
 
 
404
 
    @needs_read_lock
405
 
    def iter_merge_sorted_revisions(self, start_revision_id=None,
406
 
            stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
 
        """Walk the revisions for a branch in merge sorted order.
408
 
 
409
 
        Merge sorted order is the output from a merge-aware,
410
 
        topological sort, i.e. all parents come before their
411
 
        children going forward; the opposite for reverse.
412
 
 
413
 
        :param start_revision_id: the revision_id to begin walking from.
414
 
            If None, the branch tip is used.
415
 
        :param stop_revision_id: the revision_id to terminate the walk
416
 
            after. If None, the rest of history is included.
417
 
        :param stop_rule: if stop_revision_id is not None, the precise rule
418
 
            to use for termination:
419
 
            * 'exclude' - leave the stop revision out of the result (default)
420
 
            * 'include' - the stop revision is the last item in the result
421
 
            * 'with-merges' - include the stop revision and all of its
422
 
              merged revisions in the result
423
 
        :param direction: either 'reverse' or 'forward':
424
 
            * reverse means return the start_revision_id first, i.e.
425
 
              start at the most recent revision and go backwards in history
426
 
            * forward returns tuples in the opposite order to reverse.
427
 
              Note in particular that forward does *not* do any intelligent
428
 
              ordering w.r.t. depth as some clients of this API may like.
429
 
              (If required, that ought to be done at higher layers.)
430
 
 
431
 
        :return: an iterator over (revision_id, depth, revno, end_of_merge)
432
 
            tuples where:
433
 
 
434
 
            * revision_id: the unique id of the revision
435
 
            * depth: How many levels of merging deep this node has been
436
 
              found.
437
 
            * revno_sequence: This field provides a sequence of
438
 
              revision numbers for all revisions. The format is:
439
 
              (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
 
              branch that the revno is on. From left to right the REVNO numbers
441
 
              are the sequence numbers within that branch of the revision.
442
 
            * end_of_merge: When True the next node (earlier in history) is
443
 
              part of a different merge.
444
 
        """
445
 
        # Note: depth and revno values are in the context of the branch so
446
 
        # we need the full graph to get stable numbers, regardless of the
447
 
        # start_revision_id.
448
 
        if self._merge_sorted_revisions_cache is None:
449
 
            last_revision = self.last_revision()
450
 
            last_key = (last_revision,)
451
 
            known_graph = self.repository.revisions.get_known_graph_ancestry(
452
 
                [last_key])
453
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
 
                last_key)
455
 
        filtered = self._filter_merge_sorted_revisions(
456
 
            self._merge_sorted_revisions_cache, start_revision_id,
457
 
            stop_revision_id, stop_rule)
458
 
        if direction == 'reverse':
459
 
            return filtered
460
 
        if direction == 'forward':
461
 
            return reversed(list(filtered))
462
 
        else:
463
 
            raise ValueError('invalid direction %r' % direction)
464
 
 
465
 
    def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
466
 
        start_revision_id, stop_revision_id, stop_rule):
467
 
        """Iterate over an inclusive range of sorted revisions."""
468
 
        rev_iter = iter(merge_sorted_revisions)
469
 
        if start_revision_id is not None:
470
 
            for node in rev_iter:
471
 
                rev_id = node.key[-1]
472
 
                if rev_id != start_revision_id:
473
 
                    continue
474
 
                else:
475
 
                    # The decision to include the start or not
476
 
                    # depends on the stop_rule if a stop is provided
477
 
                    # so pop this node back into the iterator
478
 
                    rev_iter = chain(iter([node]), rev_iter)
479
 
                    break
480
 
        if stop_revision_id is None:
481
 
            # Yield everything
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
484
 
                yield (rev_id, node.merge_depth, node.revno,
485
 
                       node.end_of_merge)
486
 
        elif stop_rule == 'exclude':
487
 
            for node in rev_iter:
488
 
                rev_id = node.key[-1]
489
 
                if rev_id == stop_revision_id:
490
 
                    return
491
 
                yield (rev_id, node.merge_depth, node.revno,
492
 
                       node.end_of_merge)
493
 
        elif stop_rule == 'include':
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
498
 
                if rev_id == stop_revision_id:
499
 
                    return
500
 
        elif stop_rule == 'with-merges':
501
 
            stop_rev = self.repository.get_revision(stop_revision_id)
502
 
            if stop_rev.parent_ids:
503
 
                left_parent = stop_rev.parent_ids[0]
504
 
            else:
505
 
                left_parent = _mod_revision.NULL_REVISION
506
 
            # left_parent is the actual revision we want to stop logging at,
507
 
            # since we want to show the merged revisions after the stop_rev too
508
 
            reached_stop_revision_id = False
509
 
            revision_id_whitelist = []
510
 
            for node in rev_iter:
511
 
                rev_id = node.key[-1]
512
 
                if rev_id == left_parent:
513
 
                    # reached the left parent after the stop_revision
514
 
                    return
515
 
                if (not reached_stop_revision_id or
516
 
                        rev_id in revision_id_whitelist):
517
 
                    yield (rev_id, node.merge_depth, node.revno,
518
 
                       node.end_of_merge)
519
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
520
 
                        # only do the merged revs of rev_id from now on
521
 
                        rev = self.repository.get_revision(rev_id)
522
 
                        if rev.parent_ids:
523
 
                            reached_stop_revision_id = True
524
 
                            revision_id_whitelist.extend(rev.parent_ids)
525
 
        else:
526
 
            raise ValueError('invalid stop_rule %r' % stop_rule)
527
 
 
528
 
    def leave_lock_in_place(self):
529
 
        """Tell this branch object not to release the physical lock when this
530
 
        object is unlocked.
531
 
 
532
 
        If lock_write doesn't return a token, then this method is not supported.
533
 
        """
534
 
        self.control_files.leave_in_place()
535
 
 
536
 
    def dont_leave_lock_in_place(self):
537
 
        """Tell this branch object to release the physical lock when this
538
 
        object is unlocked, even if it didn't originally acquire it.
539
 
 
540
 
        If lock_write doesn't return a token, then this method is not supported.
541
 
        """
542
 
        self.control_files.dont_leave_in_place()
 
189
        raise NotImplementedError('get_physical_lock_status is abstract')
 
190
 
 
191
    def abspath(self, name):
 
192
        """Return absolute filename for something in the branch
 
193
        
 
194
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
195
        method and not a tree method.
 
196
        """
 
197
        raise NotImplementedError('abspath is abstract')
543
198
 
544
199
    def bind(self, other):
545
200
        """Bind the local branch the other branch.
549
204
        """
550
205
        raise errors.UpgradeRequired(self.base)
551
206
 
552
 
    def set_append_revisions_only(self, enabled):
553
 
        if not self._format.supports_set_append_revisions_only():
554
 
            raise errors.UpgradeRequired(self.base)
555
 
        if enabled:
556
 
            value = 'True'
557
 
        else:
558
 
            value = 'False'
559
 
        self.get_config().set_user_option('append_revisions_only', value,
560
 
            warn_masked=True)
561
 
 
562
 
    def set_reference_info(self, file_id, tree_path, branch_location):
563
 
        """Set the branch location to use for a tree reference."""
564
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
565
 
 
566
 
    def get_reference_info(self, file_id):
567
 
        """Get the tree_path and branch_location for a tree reference."""
568
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
569
 
 
570
207
    @needs_write_lock
571
208
    def fetch(self, from_branch, last_revision=None, pb=None):
572
209
        """Copy revisions from from_branch into this branch.
575
212
        :param last_revision: What revision to stop at (None for at the end
576
213
                              of the branch.
577
214
        :param pb: An optional progress bar to use.
578
 
        :return: None
 
215
 
 
216
        Returns the copied revision count and the failed revisions in a tuple:
 
217
        (copied, failures).
579
218
        """
580
219
        if self.base == from_branch.base:
581
220
            return (0, [])
582
 
        if pb is not None:
583
 
            symbol_versioning.warn(
584
 
                symbol_versioning.deprecated_in((1, 14, 0))
585
 
                % "pb parameter to fetch()")
 
221
        if pb is None:
 
222
            nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
223
            pb = nested_pb
 
224
        else:
 
225
            nested_pb = None
 
226
 
586
227
        from_branch.lock_read()
587
228
        try:
588
229
            if last_revision is None:
589
 
                last_revision = from_branch.last_revision()
590
 
                last_revision = _mod_revision.ensure_null(last_revision)
 
230
                pb.update('get source history')
 
231
                from_history = from_branch.revision_history()
 
232
                if from_history:
 
233
                    last_revision = from_history[-1]
 
234
                else:
 
235
                    # no history in the source branch
 
236
                    last_revision = NULL_REVISION
591
237
            return self.repository.fetch(from_branch.repository,
592
238
                                         revision_id=last_revision,
593
 
                                         pb=pb)
 
239
                                         pb=nested_pb)
594
240
        finally:
 
241
            if nested_pb is not None:
 
242
                nested_pb.finished()
595
243
            from_branch.unlock()
596
244
 
597
245
    def get_bound_location(self):
602
250
        """
603
251
        return None
604
252
 
605
 
    def get_old_bound_location(self):
606
 
        """Return the URL of the branch we used to be bound to
607
 
        """
608
 
        raise errors.UpgradeRequired(self.base)
609
 
 
610
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
611
 
                           timezone=None, committer=None, revprops=None,
612
 
                           revision_id=None):
613
 
        """Obtain a CommitBuilder for this branch.
614
 
 
615
 
        :param parents: Revision ids of the parents of the new revision.
616
 
        :param config: Optional configuration to use.
617
 
        :param timestamp: Optional timestamp recorded for commit.
618
 
        :param timezone: Optional timezone for timestamp.
619
 
        :param committer: Optional committer to set for commit.
620
 
        :param revprops: Optional dictionary of revision properties.
621
 
        :param revision_id: Optional revision id.
622
 
        """
623
 
 
624
 
        if config is None:
625
 
            config = self.get_config()
626
 
 
627
 
        return self.repository.get_commit_builder(self, parents, config,
628
 
            timestamp, timezone, committer, revprops, revision_id)
629
 
 
630
 
    def get_master_branch(self, possible_transports=None):
 
253
    def get_master_branch(self):
631
254
        """Return the branch we are bound to.
632
 
 
 
255
        
633
256
        :return: Either a Branch, or None
634
257
        """
635
258
        return None
636
259
 
637
 
    def get_revision_delta(self, revno):
638
 
        """Return the delta for one revision.
639
 
 
640
 
        The delta is relative to its mainline predecessor, or the
641
 
        empty tree for revision 1.
642
 
        """
643
 
        rh = self.revision_history()
644
 
        if not (1 <= revno <= len(rh)):
645
 
            raise errors.InvalidRevisionNumber(revno)
646
 
        return self.repository.get_revision_delta(rh[revno-1])
647
 
 
648
 
    def get_stacked_on_url(self):
649
 
        """Get the URL this branch is stacked against.
650
 
 
651
 
        :raises NotStacked: If the branch is not stacked.
652
 
        :raises UnstackableBranchFormat: If the branch does not support
653
 
            stacking.
654
 
        """
655
 
        raise NotImplementedError(self.get_stacked_on_url)
 
260
    def get_root_id(self):
 
261
        """Return the id of this branches root"""
 
262
        raise NotImplementedError('get_root_id is abstract')
656
263
 
657
264
    def print_file(self, file, revision_id):
658
265
        """Print `file` to stdout."""
659
 
        raise NotImplementedError(self.print_file)
 
266
        raise NotImplementedError('print_file is abstract')
 
267
 
 
268
    def append_revision(self, *revision_ids):
 
269
        raise NotImplementedError('append_revision is abstract')
660
270
 
661
271
    def set_revision_history(self, rev_history):
662
 
        raise NotImplementedError(self.set_revision_history)
663
 
 
664
 
    @needs_write_lock
665
 
    def set_parent(self, url):
666
 
        """See Branch.set_parent."""
667
 
        # TODO: Maybe delete old location files?
668
 
        # URLs should never be unicode, even on the local fs,
669
 
        # FIXUP this and get_parent in a future branch format bump:
670
 
        # read and rewrite the file. RBC 20060125
671
 
        if url is not None:
672
 
            if isinstance(url, unicode):
673
 
                try:
674
 
                    url = url.encode('ascii')
675
 
                except UnicodeEncodeError:
676
 
                    raise errors.InvalidURL(url,
677
 
                        "Urls must be 7-bit ascii, "
678
 
                        "use bzrlib.urlutils.escape")
679
 
            url = urlutils.relative_url(self.base, url)
680
 
        self._set_parent_location(url)
681
 
 
682
 
    @needs_write_lock
683
 
    def set_stacked_on_url(self, url):
684
 
        """Set the URL this branch is stacked against.
685
 
 
686
 
        :raises UnstackableBranchFormat: If the branch does not support
687
 
            stacking.
688
 
        :raises UnstackableRepositoryFormat: If the repository does not support
689
 
            stacking.
690
 
        """
691
 
        if not self._format.supports_stacking():
692
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
693
 
        # XXX: Changing from one fallback repository to another does not check
694
 
        # that all the data you need is present in the new fallback.
695
 
        # Possibly it should.
696
 
        self._check_stackable_repo()
697
 
        if not url:
698
 
            try:
699
 
                old_url = self.get_stacked_on_url()
700
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
701
 
                errors.UnstackableRepositoryFormat):
702
 
                return
703
 
            self._unstack()
704
 
        else:
705
 
            self._activate_fallback_location(url)
706
 
        # write this out after the repository is stacked to avoid setting a
707
 
        # stacked config that doesn't work.
708
 
        self._set_config_location('stacked_on_location', url)
709
 
 
710
 
    def _unstack(self):
711
 
        """Change a branch to be unstacked, copying data as needed.
712
 
        
713
 
        Don't call this directly, use set_stacked_on_url(None).
714
 
        """
715
 
        pb = ui.ui_factory.nested_progress_bar()
716
 
        try:
717
 
            pb.update("Unstacking")
718
 
            # The basic approach here is to fetch the tip of the branch,
719
 
            # including all available ghosts, from the existing stacked
720
 
            # repository into a new repository object without the fallbacks. 
721
 
            #
722
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
723
 
            # correct for CHKMap repostiories
724
 
            old_repository = self.repository
725
 
            if len(old_repository._fallback_repositories) != 1:
726
 
                raise AssertionError("can't cope with fallback repositories "
727
 
                    "of %r" % (self.repository,))
728
 
            # unlock it, including unlocking the fallback
729
 
            old_repository.unlock()
730
 
            old_repository.lock_read()
731
 
            try:
732
 
                # Repositories don't offer an interface to remove fallback
733
 
                # repositories today; take the conceptually simpler option and just
734
 
                # reopen it.  We reopen it starting from the URL so that we
735
 
                # get a separate connection for RemoteRepositories and can
736
 
                # stream from one of them to the other.  This does mean doing
737
 
                # separate SSH connection setup, but unstacking is not a
738
 
                # common operation so it's tolerable.
739
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
 
                new_repository = new_bzrdir.find_repository()
741
 
                self.repository = new_repository
742
 
                if self.repository._fallback_repositories:
743
 
                    raise AssertionError("didn't expect %r to have "
744
 
                        "fallback_repositories"
745
 
                        % (self.repository,))
746
 
                # this is not paired with an unlock because it's just restoring
747
 
                # the previous state; the lock's released when set_stacked_on_url
748
 
                # returns
749
 
                self.repository.lock_write()
750
 
                # XXX: If you unstack a branch while it has a working tree
751
 
                # with a pending merge, the pending-merged revisions will no
752
 
                # longer be present.  You can (probably) revert and remerge.
753
 
                #
754
 
                # XXX: This only fetches up to the tip of the repository; it
755
 
                # doesn't bring across any tags.  That's fairly consistent
756
 
                # with how branch works, but perhaps not ideal.
757
 
                self.repository.fetch(old_repository,
758
 
                    revision_id=self.last_revision(),
759
 
                    find_ghosts=True)
760
 
            finally:
761
 
                old_repository.unlock()
762
 
        finally:
763
 
            pb.finished()
764
 
 
765
 
    def _set_tags_bytes(self, bytes):
766
 
        """Mirror method for _get_tags_bytes.
767
 
 
768
 
        :seealso: Branch._get_tags_bytes.
769
 
        """
770
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
771
 
            'tags', bytes)
772
 
 
773
 
    def _cache_revision_history(self, rev_history):
774
 
        """Set the cached revision history to rev_history.
775
 
 
776
 
        The revision_history method will use this cache to avoid regenerating
777
 
        the revision history.
778
 
 
779
 
        This API is semi-public; it only for use by subclasses, all other code
780
 
        should consider it to be private.
781
 
        """
782
 
        self._revision_history_cache = rev_history
783
 
 
784
 
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
785
 
        """Set the cached revision_id => revno map to revision_id_to_revno.
786
 
 
787
 
        This API is semi-public; it only for use by subclasses, all other code
788
 
        should consider it to be private.
789
 
        """
790
 
        self._revision_id_to_revno_cache = revision_id_to_revno
791
 
 
792
 
    def _clear_cached_state(self):
793
 
        """Clear any cached data on this branch, e.g. cached revision history.
794
 
 
795
 
        This means the next call to revision_history will need to call
796
 
        _gen_revision_history.
797
 
 
798
 
        This API is semi-public; it only for use by subclasses, all other code
799
 
        should consider it to be private.
800
 
        """
801
 
        self._revision_history_cache = None
802
 
        self._revision_id_to_revno_cache = None
803
 
        self._last_revision_info_cache = None
804
 
        self._merge_sorted_revisions_cache = None
805
 
        self._partial_revision_history_cache = []
806
 
        self._partial_revision_id_to_revno_cache = {}
807
 
 
808
 
    def _gen_revision_history(self):
809
 
        """Return sequence of revision hashes on to this branch.
810
 
 
811
 
        Unlike revision_history, this method always regenerates or rereads the
812
 
        revision history, i.e. it does not cache the result, so repeated calls
813
 
        may be expensive.
814
 
 
815
 
        Concrete subclasses should override this instead of revision_history so
816
 
        that subclasses do not need to deal with caching logic.
817
 
 
818
 
        This API is semi-public; it only for use by subclasses, all other code
819
 
        should consider it to be private.
820
 
        """
821
 
        raise NotImplementedError(self._gen_revision_history)
822
 
 
823
 
    @needs_read_lock
 
272
        raise NotImplementedError('set_revision_history is abstract')
 
273
 
824
274
    def revision_history(self):
825
 
        """Return sequence of revision ids on this branch.
826
 
 
827
 
        This method will cache the revision history for as long as it is safe to
828
 
        do so.
829
 
        """
830
 
        if 'evil' in debug.debug_flags:
831
 
            mutter_callsite(3, "revision_history scales with history.")
832
 
        if self._revision_history_cache is not None:
833
 
            history = self._revision_history_cache
834
 
        else:
835
 
            history = self._gen_revision_history()
836
 
            self._cache_revision_history(history)
837
 
        return list(history)
 
275
        """Return sequence of revision hashes on to this branch."""
 
276
        raise NotImplementedError('revision_history is abstract')
838
277
 
839
278
    def revno(self):
840
279
        """Return current revision number for this branch.
842
281
        That is equivalent to the number of revisions committed to
843
282
        this branch.
844
283
        """
845
 
        return self.last_revision_info()[0]
 
284
        return len(self.revision_history())
846
285
 
847
286
    def unbind(self):
848
287
        """Older format branches cannot bind or unbind."""
849
288
        raise errors.UpgradeRequired(self.base)
850
289
 
851
290
    def last_revision(self):
852
 
        """Return last revision id, or NULL_REVISION."""
853
 
        return self.last_revision_info()[1]
854
 
 
855
 
    @needs_read_lock
856
 
    def last_revision_info(self):
857
 
        """Return information about the last revision.
858
 
 
859
 
        :return: A tuple (revno, revision_id).
860
 
        """
861
 
        if self._last_revision_info_cache is None:
862
 
            self._last_revision_info_cache = self._last_revision_info()
863
 
        return self._last_revision_info_cache
864
 
 
865
 
    def _last_revision_info(self):
866
 
        rh = self.revision_history()
867
 
        revno = len(rh)
868
 
        if revno:
869
 
            return (revno, rh[-1])
 
291
        """Return last patch hash, or None if no history."""
 
292
        ph = self.revision_history()
 
293
        if ph:
 
294
            return ph[-1]
870
295
        else:
871
 
            return (0, _mod_revision.NULL_REVISION)
 
296
            return None
872
297
 
873
 
    @deprecated_method(deprecated_in((1, 6, 0)))
874
298
    def missing_revisions(self, other, stop_revision=None):
875
299
        """Return a list of new revisions that would perfectly fit.
876
 
 
 
300
        
877
301
        If self and other have not diverged, return a list of the revisions
878
302
        present in other, but missing from self.
 
303
 
 
304
        >>> from bzrlib.workingtree import WorkingTree
 
305
        >>> bzrlib.trace.silent = True
 
306
        >>> d1 = bzrdir.ScratchDir()
 
307
        >>> br1 = d1.open_branch()
 
308
        >>> wt1 = d1.open_workingtree()
 
309
        >>> d2 = bzrdir.ScratchDir()
 
310
        >>> br2 = d2.open_branch()
 
311
        >>> wt2 = d2.open_workingtree()
 
312
        >>> br1.missing_revisions(br2)
 
313
        []
 
314
        >>> wt2.commit("lala!", rev_id="REVISION-ID-1")
 
315
        >>> br1.missing_revisions(br2)
 
316
        [u'REVISION-ID-1']
 
317
        >>> br2.missing_revisions(br1)
 
318
        []
 
319
        >>> wt1.commit("lala!", rev_id="REVISION-ID-1")
 
320
        >>> br1.missing_revisions(br2)
 
321
        []
 
322
        >>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
 
323
        >>> br1.missing_revisions(br2)
 
324
        [u'REVISION-ID-2A']
 
325
        >>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
 
326
        >>> br1.missing_revisions(br2)
 
327
        Traceback (most recent call last):
 
328
        DivergedBranches: These branches have diverged.  Try merge.
879
329
        """
880
330
        self_history = self.revision_history()
881
331
        self_len = len(self_history)
884
334
        common_index = min(self_len, other_len) -1
885
335
        if common_index >= 0 and \
886
336
            self_history[common_index] != other_history[common_index]:
887
 
            raise errors.DivergedBranches(self, other)
 
337
            raise DivergedBranches(self, other)
888
338
 
889
339
        if stop_revision is None:
890
340
            stop_revision = other_len
891
341
        else:
 
342
            assert isinstance(stop_revision, int)
892
343
            if stop_revision > other_len:
893
 
                raise errors.NoSuchRevision(self, stop_revision)
 
344
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
894
345
        return other_history[self_len:stop_revision]
895
346
 
896
 
    @needs_write_lock
897
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
898
 
                         graph=None):
 
347
    def update_revisions(self, other, stop_revision=None):
899
348
        """Pull in new perfect-fit revisions.
900
349
 
901
350
        :param other: Another Branch to pull from
902
351
        :param stop_revision: Updated until the given revision
903
 
        :param overwrite: Always set the branch pointer, rather than checking
904
 
            to see if it is a proper descendant.
905
 
        :param graph: A Graph object that can be used to query history
906
 
            information. This can be None.
907
352
        :return: None
908
353
        """
909
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
910
 
            overwrite, graph)
911
 
 
912
 
    def import_last_revision_info(self, source_repo, revno, revid):
913
 
        """Set the last revision info, importing from another repo if necessary.
914
 
 
915
 
        This is used by the bound branch code to upload a revision to
916
 
        the master branch first before updating the tip of the local branch.
917
 
 
918
 
        :param source_repo: Source repository to optionally fetch from
919
 
        :param revno: Revision number of the new tip
920
 
        :param revid: Revision id of the new tip
921
 
        """
922
 
        if not self.repository.has_same_location(source_repo):
923
 
            self.repository.fetch(source_repo, revision_id=revid)
924
 
        self.set_last_revision_info(revno, revid)
 
354
        raise NotImplementedError('update_revisions is abstract')
925
355
 
926
356
    def revision_id_to_revno(self, revision_id):
927
357
        """Given a revision id, return its revno"""
928
 
        if _mod_revision.is_null(revision_id):
 
358
        if revision_id is None:
929
359
            return 0
930
360
        history = self.revision_history()
931
361
        try:
932
362
            return history.index(revision_id) + 1
933
363
        except ValueError:
934
 
            raise errors.NoSuchRevision(self, revision_id)
 
364
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
935
365
 
936
 
    @needs_read_lock
937
366
    def get_rev_id(self, revno, history=None):
938
367
        """Find the revision id of the specified revno."""
939
368
        if revno == 0:
940
 
            return _mod_revision.NULL_REVISION
941
 
        last_revno, last_revid = self.last_revision_info()
942
 
        if revno == last_revno:
943
 
            return last_revid
944
 
        if revno <= 0 or revno > last_revno:
945
 
            raise errors.NoSuchRevision(self, revno)
946
 
        distance_from_last = last_revno - revno
947
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
948
 
            self._extend_partial_history(distance_from_last)
949
 
        return self._partial_revision_history_cache[distance_from_last]
950
 
 
951
 
    @needs_write_lock
952
 
    def pull(self, source, overwrite=False, stop_revision=None,
953
 
             possible_transports=None, *args, **kwargs):
954
 
        """Mirror source into this branch.
955
 
 
956
 
        This branch is considered to be 'local', having low latency.
957
 
 
958
 
        :returns: PullResult instance
959
 
        """
960
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
961
 
            stop_revision=stop_revision,
962
 
            possible_transports=possible_transports, *args, **kwargs)
963
 
 
964
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
965
 
        **kwargs):
966
 
        """Mirror this branch into target.
967
 
 
968
 
        This branch is considered to be 'local', having low latency.
969
 
        """
970
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
971
 
            *args, **kwargs)
972
 
 
973
 
    def lossy_push(self, target, stop_revision=None):
974
 
        """Push deltas into another branch.
975
 
 
976
 
        :note: This does not, like push, retain the revision ids from 
977
 
            the source branch and will, rather than adding bzr-specific 
978
 
            metadata, push only those semantics of the revision that can be 
979
 
            natively represented by this branch' VCS.
980
 
 
981
 
        :param target: Target branch
982
 
        :param stop_revision: Revision to push, defaults to last revision.
983
 
        :return: BranchPushResult with an extra member revidmap: 
984
 
            A dictionary mapping revision ids from the target branch 
985
 
            to new revision ids in the target branch, for each 
986
 
            revision that was pushed.
987
 
        """
988
 
        inter = InterBranch.get(self, target)
989
 
        lossy_push = getattr(inter, "lossy_push", None)
990
 
        if lossy_push is None:
991
 
            raise errors.LossyPushToSameVCS(self, target)
992
 
        return lossy_push(stop_revision)
 
369
            return None
 
370
        if history is None:
 
371
            history = self.revision_history()
 
372
        elif revno <= 0 or revno > len(history):
 
373
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
374
        return history[revno - 1]
 
375
 
 
376
    def pull(self, source, overwrite=False, stop_revision=None):
 
377
        raise NotImplementedError('pull is abstract')
993
378
 
994
379
    def basis_tree(self):
995
 
        """Return `Tree` object for last revision."""
 
380
        """Return `Tree` object for last revision.
 
381
 
 
382
        If there are no revisions yet, return an `EmptyTree`.
 
383
        """
996
384
        return self.repository.revision_tree(self.last_revision())
997
385
 
 
386
    def rename_one(self, from_rel, to_rel):
 
387
        """Rename one file.
 
388
 
 
389
        This can change the directory or the filename or both.
 
390
        """
 
391
        raise NotImplementedError('rename_one is abstract')
 
392
 
 
393
    def move(self, from_paths, to_name):
 
394
        """Rename files.
 
395
 
 
396
        to_name must exist as a versioned directory.
 
397
 
 
398
        If to_name exists and is a directory, the files are moved into
 
399
        it, keeping their old names.  If it is a directory, 
 
400
 
 
401
        Note that to_name is only the last component of the new name;
 
402
        this doesn't change the directory.
 
403
 
 
404
        This returns a list of (from_path, to_path) pairs for each
 
405
        entry that is moved.
 
406
        """
 
407
        raise NotImplementedError('move is abstract')
 
408
 
998
409
    def get_parent(self):
999
410
        """Return the parent location of the branch.
1000
411
 
1001
 
        This is the default location for pull/missing.  The usual
1002
 
        pattern is that the user can override it by specifying a
1003
 
        location.
1004
 
        """
1005
 
        parent = self._get_parent_location()
1006
 
        if parent is None:
1007
 
            return parent
1008
 
        # This is an old-format absolute path to a local branch
1009
 
        # turn it into a url
1010
 
        if parent.startswith('/'):
1011
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1012
 
        try:
1013
 
            return urlutils.join(self.base[:-1], parent)
1014
 
        except errors.InvalidURLJoin, e:
1015
 
            raise errors.InaccessibleParent(parent, self.base)
1016
 
 
1017
 
    def _get_parent_location(self):
1018
 
        raise NotImplementedError(self._get_parent_location)
1019
 
 
1020
 
    def _set_config_location(self, name, url, config=None,
1021
 
                             make_relative=False):
1022
 
        if config is None:
1023
 
            config = self.get_config()
1024
 
        if url is None:
1025
 
            url = ''
1026
 
        elif make_relative:
1027
 
            url = urlutils.relative_url(self.base, url)
1028
 
        config.set_user_option(name, url, warn_masked=True)
1029
 
 
1030
 
    def _get_config_location(self, name, config=None):
1031
 
        if config is None:
1032
 
            config = self.get_config()
1033
 
        location = config.get_user_option(name)
1034
 
        if location == '':
1035
 
            location = None
1036
 
        return location
1037
 
 
1038
 
    def get_child_submit_format(self):
1039
 
        """Return the preferred format of submissions to this branch."""
1040
 
        return self.get_config().get_user_option("child_submit_format")
1041
 
 
1042
 
    def get_submit_branch(self):
1043
 
        """Return the submit location of the branch.
1044
 
 
1045
 
        This is the default location for bundle.  The usual
1046
 
        pattern is that the user can override it by specifying a
1047
 
        location.
1048
 
        """
1049
 
        return self.get_config().get_user_option('submit_branch')
1050
 
 
1051
 
    def set_submit_branch(self, location):
1052
 
        """Return the submit location of the branch.
1053
 
 
1054
 
        This is the default location for bundle.  The usual
1055
 
        pattern is that the user can override it by specifying a
1056
 
        location.
1057
 
        """
1058
 
        self.get_config().set_user_option('submit_branch', location,
1059
 
            warn_masked=True)
1060
 
 
1061
 
    def get_public_branch(self):
1062
 
        """Return the public location of the branch.
1063
 
 
1064
 
        This is used by merge directives.
1065
 
        """
1066
 
        return self._get_config_location('public_branch')
1067
 
 
1068
 
    def set_public_branch(self, location):
1069
 
        """Return the submit location of the branch.
1070
 
 
1071
 
        This is the default location for bundle.  The usual
1072
 
        pattern is that the user can override it by specifying a
1073
 
        location.
1074
 
        """
1075
 
        self._set_config_location('public_branch', location)
 
412
        This is the default location for push/pull/missing.  The usual
 
413
        pattern is that the user can override it by specifying a
 
414
        location.
 
415
        """
 
416
        raise NotImplementedError('get_parent is abstract')
1076
417
 
1077
418
    def get_push_location(self):
1078
419
        """Return the None or the location to push this branch to."""
1079
 
        push_loc = self.get_config().get_user_option('push_location')
1080
 
        return push_loc
 
420
        raise NotImplementedError('get_push_location is abstract')
1081
421
 
1082
422
    def set_push_location(self, location):
1083
423
        """Set a new push location for this branch."""
1084
 
        raise NotImplementedError(self.set_push_location)
1085
 
 
1086
 
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1087
 
        """Run the post_change_branch_tip hooks."""
1088
 
        hooks = Branch.hooks['post_change_branch_tip']
1089
 
        if not hooks:
1090
 
            return
1091
 
        new_revno, new_revid = self.last_revision_info()
1092
 
        params = ChangeBranchTipParams(
1093
 
            self, old_revno, new_revno, old_revid, new_revid)
1094
 
        for hook in hooks:
1095
 
            hook(params)
1096
 
 
1097
 
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1098
 
        """Run the pre_change_branch_tip hooks."""
1099
 
        hooks = Branch.hooks['pre_change_branch_tip']
1100
 
        if not hooks:
1101
 
            return
1102
 
        old_revno, old_revid = self.last_revision_info()
1103
 
        params = ChangeBranchTipParams(
1104
 
            self, old_revno, new_revno, old_revid, new_revid)
1105
 
        for hook in hooks:
1106
 
            hook(params)
 
424
        raise NotImplementedError('set_push_location is abstract')
 
425
 
 
426
    def set_parent(self, url):
 
427
        raise NotImplementedError('set_parent is abstract')
1107
428
 
1108
429
    @needs_write_lock
1109
430
    def update(self):
1110
 
        """Synchronise this branch with the master branch if any.
 
431
        """Synchronise this branch with the master branch if any. 
1111
432
 
1112
433
        :return: None or the last_revision pivoted out during the update.
1113
434
        """
1120
441
        """
1121
442
        if revno != 0:
1122
443
            self.check_real_revno(revno)
1123
 
 
 
444
            
1124
445
    def check_real_revno(self, revno):
1125
446
        """\
1126
447
        Check whether a revno corresponds to a real revision.
1127
448
        Zero (the NULL revision) is considered invalid
1128
449
        """
1129
450
        if revno < 1 or revno > self.revno():
1130
 
            raise errors.InvalidRevisionNumber(revno)
 
451
            raise InvalidRevisionNumber(revno)
1131
452
 
1132
453
    @needs_read_lock
1133
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
454
    def clone(self, *args, **kwargs):
1134
455
        """Clone this branch into to_bzrdir preserving all semantic values.
1135
 
 
1136
 
        Most API users will want 'create_clone_on_transport', which creates a
1137
 
        new bzrdir and branch on the fly.
1138
 
 
 
456
        
1139
457
        revision_id: if not None, the revision history in the new branch will
1140
458
                     be truncated to end with revision_id.
1141
459
        """
1142
 
        result = to_bzrdir.create_branch()
1143
 
        result.lock_write()
1144
 
        try:
1145
 
            if repository_policy is not None:
1146
 
                repository_policy.configure_branch(result)
1147
 
            self.copy_content_into(result, revision_id=revision_id)
1148
 
        finally:
1149
 
            result.unlock()
1150
 
        return result
 
460
        # for API compatability, until 0.8 releases we provide the old api:
 
461
        # def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
 
462
        # after 0.8 releases, the *args and **kwargs should be changed:
 
463
        # def clone(self, to_bzrdir, revision_id=None):
 
464
        if (kwargs.get('to_location', None) or
 
465
            kwargs.get('revision', None) or
 
466
            kwargs.get('basis_branch', None) or
 
467
            (len(args) and isinstance(args[0], basestring))):
 
468
            # backwards compatability api:
 
469
            warn("Branch.clone() has been deprecated for BzrDir.clone() from"
 
470
                 " bzrlib 0.8.", DeprecationWarning, stacklevel=3)
 
471
            # get basis_branch
 
472
            if len(args) > 2:
 
473
                basis_branch = args[2]
 
474
            else:
 
475
                basis_branch = kwargs.get('basis_branch', None)
 
476
            if basis_branch:
 
477
                basis = basis_branch.bzrdir
 
478
            else:
 
479
                basis = None
 
480
            # get revision
 
481
            if len(args) > 1:
 
482
                revision_id = args[1]
 
483
            else:
 
484
                revision_id = kwargs.get('revision', None)
 
485
            # get location
 
486
            if len(args):
 
487
                url = args[0]
 
488
            else:
 
489
                # no default to raise if not provided.
 
490
                url = kwargs.get('to_location')
 
491
            return self.bzrdir.clone(url,
 
492
                                     revision_id=revision_id,
 
493
                                     basis=basis).open_branch()
 
494
        # new cleaner api.
 
495
        # generate args by hand 
 
496
        if len(args) > 1:
 
497
            revision_id = args[1]
 
498
        else:
 
499
            revision_id = kwargs.get('revision_id', None)
 
500
        if len(args):
 
501
            to_bzrdir = args[0]
 
502
        else:
 
503
            # no default to raise if not provided.
 
504
            to_bzrdir = kwargs.get('to_bzrdir')
 
505
        result = self._format.initialize(to_bzrdir)
 
506
        self.copy_content_into(result, revision_id=revision_id)
 
507
        return  result
1151
508
 
1152
509
    @needs_read_lock
1153
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
510
    def sprout(self, to_bzrdir, revision_id=None):
1154
511
        """Create a new line of development from the branch, into to_bzrdir.
1155
 
 
1156
 
        to_bzrdir controls the branch format.
1157
 
 
 
512
        
1158
513
        revision_id: if not None, the revision history in the new branch will
1159
514
                     be truncated to end with revision_id.
1160
515
        """
1161
 
        if (repository_policy is not None and
1162
 
            repository_policy.requires_stacking()):
1163
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1164
 
        result = to_bzrdir.create_branch()
1165
 
        result.lock_write()
1166
 
        try:
1167
 
            if repository_policy is not None:
1168
 
                repository_policy.configure_branch(result)
1169
 
            self.copy_content_into(result, revision_id=revision_id)
1170
 
            result.set_parent(self.bzrdir.root_transport.base)
1171
 
        finally:
1172
 
            result.unlock()
 
516
        result = self._format.initialize(to_bzrdir)
 
517
        self.copy_content_into(result, revision_id=revision_id)
 
518
        result.set_parent(self.bzrdir.root_transport.base)
1173
519
        return result
1174
520
 
1175
 
    def _synchronize_history(self, destination, revision_id):
1176
 
        """Synchronize last revision and revision history between branches.
1177
 
 
1178
 
        This version is most efficient when the destination is also a
1179
 
        BzrBranch6, but works for BzrBranch5, as long as the destination's
1180
 
        repository contains all the lefthand ancestors of the intended
1181
 
        last_revision.  If not, set_last_revision_info will fail.
1182
 
 
1183
 
        :param destination: The branch to copy the history into
1184
 
        :param revision_id: The revision-id to truncate history at.  May
1185
 
          be None to copy complete history.
1186
 
        """
1187
 
        source_revno, source_revision_id = self.last_revision_info()
1188
 
        if revision_id is None:
1189
 
            revno, revision_id = source_revno, source_revision_id
1190
 
        else:
1191
 
            graph = self.repository.get_graph()
1192
 
            try:
1193
 
                revno = graph.find_distance_to_null(revision_id, 
1194
 
                    [(source_revision_id, source_revno)])
1195
 
            except errors.GhostRevisionsHaveNoRevno:
1196
 
                # Default to 1, if we can't find anything else
1197
 
                revno = 1
1198
 
        destination.set_last_revision_info(revno, revision_id)
1199
 
 
1200
521
    @needs_read_lock
1201
522
    def copy_content_into(self, destination, revision_id=None):
1202
523
        """Copy the content of self into destination.
1204
525
        revision_id: if not None, the revision history in the new branch will
1205
526
                     be truncated to end with revision_id.
1206
527
        """
1207
 
        self.update_references(destination)
1208
 
        self._synchronize_history(destination, revision_id)
1209
 
        try:
1210
 
            parent = self.get_parent()
1211
 
        except errors.InaccessibleParent, e:
1212
 
            mutter('parent was not accessible to copy: %s', e)
1213
 
        else:
1214
 
            if parent:
1215
 
                destination.set_parent(parent)
1216
 
        if self._push_should_merge_tags():
1217
 
            self.tags.merge_to(destination.tags)
1218
 
 
1219
 
    def update_references(self, target):
1220
 
        if not getattr(self._format, 'supports_reference_locations', False):
1221
 
            return
1222
 
        reference_dict = self._get_all_reference_info()
1223
 
        if len(reference_dict) == 0:
1224
 
            return
1225
 
        old_base = self.base
1226
 
        new_base = target.base
1227
 
        target_reference_dict = target._get_all_reference_info()
1228
 
        for file_id, (tree_path, branch_location) in (
1229
 
            reference_dict.items()):
1230
 
            branch_location = urlutils.rebase_url(branch_location,
1231
 
                                                  old_base, new_base)
1232
 
            target_reference_dict.setdefault(
1233
 
                file_id, (tree_path, branch_location))
1234
 
        target._set_all_reference_info(target_reference_dict)
1235
 
 
1236
 
    @needs_read_lock
1237
 
    def check(self, refs):
1238
 
        """Check consistency of the branch.
1239
 
 
1240
 
        In particular this checks that revisions given in the revision-history
1241
 
        do actually match up in the revision graph, and that they're all
1242
 
        present in the repository.
1243
 
 
1244
 
        Callers will typically also want to check the repository.
1245
 
 
1246
 
        :param refs: Calculated refs for this branch as specified by
1247
 
            branch._get_check_refs()
1248
 
        :return: A BranchCheckResult.
1249
 
        """
1250
 
        result = BranchCheckResult(self)
1251
 
        last_revno, last_revision_id = self.last_revision_info()
1252
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1253
 
        if actual_revno != last_revno:
1254
 
            result.errors.append(errors.BzrCheckError(
1255
 
                'revno does not match len(mainline) %s != %s' % (
1256
 
                last_revno, actual_revno)))
1257
 
        # TODO: We should probably also check that self.revision_history
1258
 
        # matches the repository for older branch formats.
1259
 
        # If looking for the code that cross-checks repository parents against
1260
 
        # the iter_reverse_revision_history output, that is now a repository
1261
 
        # specific check.
1262
 
        return result
1263
 
 
1264
 
    def _get_checkout_format(self):
1265
 
        """Return the most suitable metadir for a checkout of this branch.
1266
 
        Weaves are used if this branch's repository uses weaves.
1267
 
        """
1268
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1269
 
            from bzrlib.repofmt import weaverepo
1270
 
            format = bzrdir.BzrDirMetaFormat1()
1271
 
            format.repository_format = weaverepo.RepositoryFormat7()
1272
 
        else:
1273
 
            format = self.repository.bzrdir.checkout_metadir()
1274
 
            format.set_branch_format(self._format)
1275
 
        return format
1276
 
 
1277
 
    def create_clone_on_transport(self, to_transport, revision_id=None,
1278
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1279
 
        """Create a clone of this branch and its bzrdir.
1280
 
 
1281
 
        :param to_transport: The transport to clone onto.
1282
 
        :param revision_id: The revision id to use as tip in the new branch.
1283
 
            If None the tip is obtained from this branch.
1284
 
        :param stacked_on: An optional URL to stack the clone on.
1285
 
        :param create_prefix: Create any missing directories leading up to
1286
 
            to_transport.
1287
 
        :param use_existing_dir: Use an existing directory if one exists.
1288
 
        """
1289
 
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1290
 
        # clone call. Or something. 20090224 RBC/spiv.
1291
 
        if revision_id is None:
1292
 
            revision_id = self.last_revision()
1293
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1294
 
            revision_id=revision_id, stacked_on=stacked_on,
1295
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1296
 
        return dir_to.open_branch()
1297
 
 
1298
 
    def create_checkout(self, to_location, revision_id=None,
1299
 
                        lightweight=False, accelerator_tree=None,
1300
 
                        hardlink=False):
1301
 
        """Create a checkout of a branch.
1302
 
 
1303
 
        :param to_location: The url to produce the checkout at
1304
 
        :param revision_id: The revision to check out
1305
 
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1306
 
        produce a bound branch (heavyweight checkout)
1307
 
        :param accelerator_tree: A tree which can be used for retrieving file
1308
 
            contents more quickly than the revision tree, i.e. a workingtree.
1309
 
            The revision tree will be used for cases where accelerator_tree's
1310
 
            content is different.
1311
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1312
 
            where possible.
1313
 
        :return: The tree of the created checkout
1314
 
        """
1315
 
        t = transport.get_transport(to_location)
1316
 
        t.ensure_base()
1317
 
        if lightweight:
1318
 
            format = self._get_checkout_format()
1319
 
            checkout = format.initialize_on_transport(t)
1320
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1321
 
        else:
1322
 
            format = self._get_checkout_format()
1323
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1324
 
                to_location, force_new_tree=False, format=format)
1325
 
            checkout = checkout_branch.bzrdir
1326
 
            checkout_branch.bind(self)
1327
 
            # pull up to the specified revision_id to set the initial
1328
 
            # branch tip correctly, and seed it with history.
1329
 
            checkout_branch.pull(self, stop_revision=revision_id)
1330
 
            from_branch=None
1331
 
        tree = checkout.create_workingtree(revision_id,
1332
 
                                           from_branch=from_branch,
1333
 
                                           accelerator_tree=accelerator_tree,
1334
 
                                           hardlink=hardlink)
1335
 
        basis_tree = tree.basis_tree()
1336
 
        basis_tree.lock_read()
1337
 
        try:
1338
 
            for path, file_id in basis_tree.iter_references():
1339
 
                reference_parent = self.reference_parent(file_id, path)
1340
 
                reference_parent.create_checkout(tree.abspath(path),
1341
 
                    basis_tree.get_reference_revision(file_id, path),
1342
 
                    lightweight)
1343
 
        finally:
1344
 
            basis_tree.unlock()
1345
 
        return tree
1346
 
 
1347
 
    @needs_write_lock
1348
 
    def reconcile(self, thorough=True):
1349
 
        """Make sure the data stored in this branch is consistent."""
1350
 
        from bzrlib.reconcile import BranchReconciler
1351
 
        reconciler = BranchReconciler(self, thorough=thorough)
1352
 
        reconciler.reconcile()
1353
 
        return reconciler
1354
 
 
1355
 
    def reference_parent(self, file_id, path, possible_transports=None):
1356
 
        """Return the parent branch for a tree-reference file_id
1357
 
        :param file_id: The file_id of the tree reference
1358
 
        :param path: The path of the file_id in the tree
1359
 
        :return: A branch associated with the file_id
1360
 
        """
1361
 
        # FIXME should provide multiple branches, based on config
1362
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1363
 
                           possible_transports=possible_transports)
1364
 
 
1365
 
    def supports_tags(self):
1366
 
        return self._format.supports_tags()
1367
 
 
1368
 
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1369
 
                                         other_branch):
1370
 
        """Ensure that revision_b is a descendant of revision_a.
1371
 
 
1372
 
        This is a helper function for update_revisions.
1373
 
 
1374
 
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1375
 
        :returns: True if revision_b is a descendant of revision_a.
1376
 
        """
1377
 
        relation = self._revision_relations(revision_a, revision_b, graph)
1378
 
        if relation == 'b_descends_from_a':
1379
 
            return True
1380
 
        elif relation == 'diverged':
1381
 
            raise errors.DivergedBranches(self, other_branch)
1382
 
        elif relation == 'a_descends_from_b':
1383
 
            return False
1384
 
        else:
1385
 
            raise AssertionError("invalid relation: %r" % (relation,))
1386
 
 
1387
 
    def _revision_relations(self, revision_a, revision_b, graph):
1388
 
        """Determine the relationship between two revisions.
1389
 
 
1390
 
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1391
 
        """
1392
 
        heads = graph.heads([revision_a, revision_b])
1393
 
        if heads == set([revision_b]):
1394
 
            return 'b_descends_from_a'
1395
 
        elif heads == set([revision_a, revision_b]):
1396
 
            # These branches have diverged
1397
 
            return 'diverged'
1398
 
        elif heads == set([revision_a]):
1399
 
            return 'a_descends_from_b'
1400
 
        else:
1401
 
            raise AssertionError("invalid heads: %r" % (heads,))
 
528
        new_history = self.revision_history()
 
529
        if revision_id is not None:
 
530
            try:
 
531
                new_history = new_history[:new_history.index(revision_id) + 1]
 
532
            except ValueError:
 
533
                rev = self.repository.get_revision(revision_id)
 
534
                new_history = rev.get_history(self.repository)[1:]
 
535
        destination.set_revision_history(new_history)
 
536
        parent = self.get_parent()
 
537
        if parent:
 
538
            destination.set_parent(parent)
1402
539
 
1403
540
 
1404
541
class BranchFormat(object):
1409
546
     * a format string,
1410
547
     * an open routine.
1411
548
 
1412
 
    Formats are placed in an dict by their format string for reference
 
549
    Formats are placed in an dict by their format string for reference 
1413
550
    during branch opening. Its not required that these be instances, they
1414
 
    can be classes themselves with class methods - it simply depends on
 
551
    can be classes themselves with class methods - it simply depends on 
1415
552
    whether state is needed for a given format or not.
1416
553
 
1417
554
    Once a format is deprecated, just deprecate the initialize and open
1418
 
    methods on the format class. Do not deprecate the object, as the
 
555
    methods on the format class. Do not deprecate the object, as the 
1419
556
    object will be created every time regardless.
1420
557
    """
1421
558
 
1425
562
    _formats = {}
1426
563
    """The known formats."""
1427
564
 
1428
 
    can_set_append_revisions_only = True
1429
 
 
1430
 
    def __eq__(self, other):
1431
 
        return self.__class__ is other.__class__
1432
 
 
1433
 
    def __ne__(self, other):
1434
 
        return not (self == other)
1435
 
 
1436
565
    @classmethod
1437
566
    def find_format(klass, a_bzrdir):
1438
567
        """Return the format for the branch object in a_bzrdir."""
1439
568
        try:
1440
569
            transport = a_bzrdir.get_branch_transport(None)
1441
 
            format_string = transport.get_bytes("format")
 
570
            format_string = transport.get("format").read()
1442
571
            return klass._formats[format_string]
1443
 
        except errors.NoSuchFile:
1444
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
572
        except NoSuchFile:
 
573
            raise NotBranchError(path=transport.base)
1445
574
        except KeyError:
1446
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
575
            raise errors.UnknownFormatError(format_string)
1447
576
 
1448
577
    @classmethod
1449
578
    def get_default_format(klass):
1450
579
        """Return the current default format."""
1451
580
        return klass._default_format
1452
581
 
1453
 
    def get_reference(self, a_bzrdir):
1454
 
        """Get the target reference of the branch in a_bzrdir.
1455
 
 
1456
 
        format probing must have been completed before calling
1457
 
        this method - it is assumed that the format of the branch
1458
 
        in a_bzrdir is correct.
1459
 
 
1460
 
        :param a_bzrdir: The bzrdir to get the branch data from.
1461
 
        :return: None if the branch is not a reference branch.
1462
 
        """
1463
 
        return None
1464
 
 
1465
 
    @classmethod
1466
 
    def set_reference(self, a_bzrdir, to_branch):
1467
 
        """Set the target reference of the branch in a_bzrdir.
1468
 
 
1469
 
        format probing must have been completed before calling
1470
 
        this method - it is assumed that the format of the branch
1471
 
        in a_bzrdir is correct.
1472
 
 
1473
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
1474
 
        :param to_branch: branch that the checkout is to reference
1475
 
        """
1476
 
        raise NotImplementedError(self.set_reference)
1477
 
 
1478
582
    def get_format_string(self):
1479
583
        """Return the ASCII format string that identifies this format."""
1480
584
        raise NotImplementedError(self.get_format_string)
1481
585
 
1482
586
    def get_format_description(self):
1483
587
        """Return the short format description for this format."""
1484
 
        raise NotImplementedError(self.get_format_description)
1485
 
 
1486
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1487
 
                           set_format=True):
1488
 
        """Initialize a branch in a bzrdir, with specified files
1489
 
 
1490
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1491
 
        :param utf8_files: The files to create as a list of
1492
 
            (filename, content) tuples
1493
 
        :param set_format: If True, set the format with
1494
 
            self.get_format_string.  (BzrBranch4 has its format set
1495
 
            elsewhere)
1496
 
        :return: a branch in this format
1497
 
        """
1498
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1499
 
        branch_transport = a_bzrdir.get_branch_transport(self)
1500
 
        lock_map = {
1501
 
            'metadir': ('lock', lockdir.LockDir),
1502
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1503
 
        }
1504
 
        lock_name, lock_class = lock_map[lock_type]
1505
 
        control_files = lockable_files.LockableFiles(branch_transport,
1506
 
            lock_name, lock_class)
1507
 
        control_files.create_lock()
1508
 
        try:
1509
 
            control_files.lock_write()
1510
 
        except errors.LockContention:
1511
 
            if lock_type != 'branch4':
1512
 
                raise
1513
 
            lock_taken = False
1514
 
        else:
1515
 
            lock_taken = True
1516
 
        if set_format:
1517
 
            utf8_files += [('format', self.get_format_string())]
1518
 
        try:
1519
 
            for (filename, content) in utf8_files:
1520
 
                branch_transport.put_bytes(
1521
 
                    filename, content,
1522
 
                    mode=a_bzrdir._get_file_mode())
1523
 
        finally:
1524
 
            if lock_taken:
1525
 
                control_files.unlock()
1526
 
        return self.open(a_bzrdir, _found=True)
 
588
        raise NotImplementedError(self.get_format_string)
1527
589
 
1528
590
    def initialize(self, a_bzrdir):
1529
591
        """Create a branch of this format in a_bzrdir."""
1530
 
        raise NotImplementedError(self.initialize)
 
592
        raise NotImplementedError(self.initialized)
1531
593
 
1532
594
    def is_supported(self):
1533
595
        """Is this format supported?
1534
596
 
1535
597
        Supported formats can be initialized and opened.
1536
 
        Unsupported formats may not support initialization or committing or
 
598
        Unsupported formats may not support initialization or committing or 
1537
599
        some other features depending on the reason for not being supported.
1538
600
        """
1539
601
        return True
1540
602
 
1541
 
    def make_tags(self, branch):
1542
 
        """Create a tags object for branch.
1543
 
 
1544
 
        This method is on BranchFormat, because BranchFormats are reflected
1545
 
        over the wire via network_name(), whereas full Branch instances require
1546
 
        multiple VFS method calls to operate at all.
1547
 
 
1548
 
        The default implementation returns a disabled-tags instance.
1549
 
 
1550
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1551
 
        on a RemoteBranch.
1552
 
        """
1553
 
        return DisabledTags(branch)
1554
 
 
1555
 
    def network_name(self):
1556
 
        """A simple byte string uniquely identifying this format for RPC calls.
1557
 
 
1558
 
        MetaDir branch formats use their disk format string to identify the
1559
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1560
 
        foreign formats like svn/git and hg should use some marker which is
1561
 
        unique and immutable.
1562
 
        """
1563
 
        raise NotImplementedError(self.network_name)
1564
 
 
1565
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
603
    def open(self, a_bzrdir, _found=False):
1566
604
        """Return the branch object for a_bzrdir
1567
605
 
1568
 
        :param a_bzrdir: A BzrDir that contains a branch.
1569
 
        :param _found: a private parameter, do not use it. It is used to
1570
 
            indicate if format probing has already be done.
1571
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1572
 
            (if there are any).  Default is to open fallbacks.
 
606
        _found is a private parameter, do not use it. It is used to indicate
 
607
               if format probing has already be done.
1573
608
        """
1574
609
        raise NotImplementedError(self.open)
1575
610
 
1576
611
    @classmethod
1577
612
    def register_format(klass, format):
1578
 
        """Register a metadir format."""
1579
613
        klass._formats[format.get_format_string()] = format
1580
 
        # Metadir formats have a network name of their format string, and get
1581
 
        # registered as class factories.
1582
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1583
614
 
1584
615
    @classmethod
1585
616
    def set_default_format(klass, format):
1586
617
        klass._default_format = format
1587
618
 
1588
 
    def supports_set_append_revisions_only(self):
1589
 
        """True if this format supports set_append_revisions_only."""
1590
 
        return False
1591
 
 
1592
 
    def supports_stacking(self):
1593
 
        """True if this format records a stacked-on branch."""
1594
 
        return False
1595
 
 
1596
619
    @classmethod
1597
620
    def unregister_format(klass, format):
 
621
        assert klass._formats[format.get_format_string()] is format
1598
622
        del klass._formats[format.get_format_string()]
1599
623
 
1600
624
    def __str__(self):
1601
 
        return self.get_format_description().rstrip()
1602
 
 
1603
 
    def supports_tags(self):
1604
 
        """True if this format supports tags stored in the branch"""
1605
 
        return False  # by default
1606
 
 
1607
 
 
1608
 
class BranchHooks(Hooks):
1609
 
    """A dictionary mapping hook name to a list of callables for branch hooks.
1610
 
 
1611
 
    e.g. ['set_rh'] Is the list of items to be called when the
1612
 
    set_revision_history function is invoked.
1613
 
    """
1614
 
 
1615
 
    def __init__(self):
1616
 
        """Create the default hooks.
1617
 
 
1618
 
        These are all empty initially, because by default nothing should get
1619
 
        notified.
1620
 
        """
1621
 
        Hooks.__init__(self)
1622
 
        self.create_hook(HookPoint('set_rh',
1623
 
            "Invoked whenever the revision history has been set via "
1624
 
            "set_revision_history. The api signature is (branch, "
1625
 
            "revision_history), and the branch will be write-locked. "
1626
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1627
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1628
 
        self.create_hook(HookPoint('open',
1629
 
            "Called with the Branch object that has been opened after a "
1630
 
            "branch is opened.", (1, 8), None))
1631
 
        self.create_hook(HookPoint('post_push',
1632
 
            "Called after a push operation completes. post_push is called "
1633
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1634
 
            "bzr client.", (0, 15), None))
1635
 
        self.create_hook(HookPoint('post_pull',
1636
 
            "Called after a pull operation completes. post_pull is called "
1637
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1638
 
            "bzr client.", (0, 15), None))
1639
 
        self.create_hook(HookPoint('pre_commit',
1640
 
            "Called after a commit is calculated but before it is is "
1641
 
            "completed. pre_commit is called with (local, master, old_revno, "
1642
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1643
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1644
 
            "tree_delta is a TreeDelta object describing changes from the "
1645
 
            "basis revision. hooks MUST NOT modify this delta. "
1646
 
            " future_tree is an in-memory tree obtained from "
1647
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1648
 
            "tree.", (0,91), None))
1649
 
        self.create_hook(HookPoint('post_commit',
1650
 
            "Called in the bzr client after a commit has completed. "
1651
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1652
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1653
 
            "commit to a branch.", (0, 15), None))
1654
 
        self.create_hook(HookPoint('post_uncommit',
1655
 
            "Called in the bzr client after an uncommit completes. "
1656
 
            "post_uncommit is called with (local, master, old_revno, "
1657
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1658
 
            "or None, master is the target branch, and an empty branch "
1659
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1660
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1661
 
            "Called in bzr client and server before a change to the tip of a "
1662
 
            "branch is made. pre_change_branch_tip is called with a "
1663
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1664
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1665
 
        self.create_hook(HookPoint('post_change_branch_tip',
1666
 
            "Called in bzr client and server after a change to the tip of a "
1667
 
            "branch is made. post_change_branch_tip is called with a "
1668
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1669
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1670
 
        self.create_hook(HookPoint('transform_fallback_location',
1671
 
            "Called when a stacked branch is activating its fallback "
1672
 
            "locations. transform_fallback_location is called with (branch, "
1673
 
            "url), and should return a new url. Returning the same url "
1674
 
            "allows it to be used as-is, returning a different one can be "
1675
 
            "used to cause the branch to stack on a closer copy of that "
1676
 
            "fallback_location. Note that the branch cannot have history "
1677
 
            "accessing methods called on it during this hook because the "
1678
 
            "fallback locations have not been activated. When there are "
1679
 
            "multiple hooks installed for transform_fallback_location, "
1680
 
            "all are called with the url returned from the previous hook."
1681
 
            "The order is however undefined.", (1, 9), None))
1682
 
 
1683
 
 
1684
 
# install the default hooks into the Branch class.
1685
 
Branch.hooks = BranchHooks()
1686
 
 
1687
 
 
1688
 
class ChangeBranchTipParams(object):
1689
 
    """Object holding parameters passed to *_change_branch_tip hooks.
1690
 
 
1691
 
    There are 5 fields that hooks may wish to access:
1692
 
 
1693
 
    :ivar branch: the branch being changed
1694
 
    :ivar old_revno: revision number before the change
1695
 
    :ivar new_revno: revision number after the change
1696
 
    :ivar old_revid: revision id before the change
1697
 
    :ivar new_revid: revision id after the change
1698
 
 
1699
 
    The revid fields are strings. The revno fields are integers.
1700
 
    """
1701
 
 
1702
 
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1703
 
        """Create a group of ChangeBranchTip parameters.
1704
 
 
1705
 
        :param branch: The branch being changed.
1706
 
        :param old_revno: Revision number before the change.
1707
 
        :param new_revno: Revision number after the change.
1708
 
        :param old_revid: Tip revision id before the change.
1709
 
        :param new_revid: Tip revision id after the change.
1710
 
        """
1711
 
        self.branch = branch
1712
 
        self.old_revno = old_revno
1713
 
        self.new_revno = new_revno
1714
 
        self.old_revid = old_revid
1715
 
        self.new_revid = new_revid
1716
 
 
1717
 
    def __eq__(self, other):
1718
 
        return self.__dict__ == other.__dict__
1719
 
 
1720
 
    def __repr__(self):
1721
 
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1722
 
            self.__class__.__name__, self.branch,
1723
 
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
 
625
        return self.get_format_string().rstrip()
1724
626
 
1725
627
 
1726
628
class BzrBranchFormat4(BranchFormat):
1737
639
 
1738
640
    def initialize(self, a_bzrdir):
1739
641
        """Create a branch of this format in a_bzrdir."""
 
642
        mutter('creating branch in %s', a_bzrdir.transport.base)
 
643
        branch_transport = a_bzrdir.get_branch_transport(self)
1740
644
        utf8_files = [('revision-history', ''),
1741
645
                      ('branch-name', ''),
1742
646
                      ]
1743
 
        return self._initialize_helper(a_bzrdir, utf8_files,
1744
 
                                       lock_type='branch4', set_format=False)
 
647
        control_files = LockableFiles(branch_transport, 'branch-lock',
 
648
                                      TransportLock)
 
649
        control_files.create_lock()
 
650
        control_files.lock_write()
 
651
        try:
 
652
            for file, content in utf8_files:
 
653
                control_files.put_utf8(file, content)
 
654
        finally:
 
655
            control_files.unlock()
 
656
        return self.open(a_bzrdir, _found=True)
1745
657
 
1746
658
    def __init__(self):
1747
659
        super(BzrBranchFormat4, self).__init__()
1748
660
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1749
661
 
1750
 
    def network_name(self):
1751
 
        """The network name for this format is the control dirs disk label."""
1752
 
        return self._matchingbzrdir.get_format_string()
 
662
    def open(self, a_bzrdir, _found=False):
 
663
        """Return the branch object for a_bzrdir
1753
664
 
1754
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1755
 
        """See BranchFormat.open()."""
 
665
        _found is a private parameter, do not use it. It is used to indicate
 
666
               if format probing has already be done.
 
667
        """
1756
668
        if not _found:
1757
669
            # we are being called directly and must probe.
1758
670
            raise NotImplementedError
1765
677
        return "Bazaar-NG branch format 4"
1766
678
 
1767
679
 
1768
 
class BranchFormatMetadir(BranchFormat):
1769
 
    """Common logic for meta-dir based branch formats."""
1770
 
 
1771
 
    def _branch_class(self):
1772
 
        """What class to instantiate on open calls."""
1773
 
        raise NotImplementedError(self._branch_class)
1774
 
 
1775
 
    def network_name(self):
1776
 
        """A simple byte string uniquely identifying this format for RPC calls.
1777
 
 
1778
 
        Metadir branch formats use their format string.
1779
 
        """
1780
 
        return self.get_format_string()
1781
 
 
1782
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1783
 
        """See BranchFormat.open()."""
1784
 
        if not _found:
1785
 
            format = BranchFormat.find_format(a_bzrdir)
1786
 
            if format.__class__ != self.__class__:
1787
 
                raise AssertionError("wrong format %r found for %r" %
1788
 
                    (format, self))
1789
 
        try:
1790
 
            transport = a_bzrdir.get_branch_transport(None)
1791
 
            control_files = lockable_files.LockableFiles(transport, 'lock',
1792
 
                                                         lockdir.LockDir)
1793
 
            return self._branch_class()(_format=self,
1794
 
                              _control_files=control_files,
1795
 
                              a_bzrdir=a_bzrdir,
1796
 
                              _repository=a_bzrdir.find_repository(),
1797
 
                              ignore_fallbacks=ignore_fallbacks)
1798
 
        except errors.NoSuchFile:
1799
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1800
 
 
1801
 
    def __init__(self):
1802
 
        super(BranchFormatMetadir, self).__init__()
1803
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1804
 
        self._matchingbzrdir.set_branch_format(self)
1805
 
 
1806
 
    def supports_tags(self):
1807
 
        return True
1808
 
 
1809
 
 
1810
 
class BzrBranchFormat5(BranchFormatMetadir):
 
680
class BzrBranchFormat5(BranchFormat):
1811
681
    """Bzr branch format 5.
1812
682
 
1813
683
    This format has:
1820
690
    This format is new in bzr 0.8.
1821
691
    """
1822
692
 
1823
 
    def _branch_class(self):
1824
 
        return BzrBranch5
1825
 
 
1826
693
    def get_format_string(self):
1827
694
        """See BranchFormat.get_format_string()."""
1828
695
        return "Bazaar-NG branch format 5\n"
1830
697
    def get_format_description(self):
1831
698
        """See BranchFormat.get_format_description()."""
1832
699
        return "Branch format 5"
1833
 
 
 
700
        
1834
701
    def initialize(self, a_bzrdir):
1835
702
        """Create a branch of this format in a_bzrdir."""
 
703
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
704
        branch_transport = a_bzrdir.get_branch_transport(self)
1836
705
        utf8_files = [('revision-history', ''),
1837
706
                      ('branch-name', ''),
1838
707
                      ]
1839
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1840
 
 
1841
 
    def supports_tags(self):
1842
 
        return False
1843
 
 
1844
 
 
1845
 
class BzrBranchFormat6(BranchFormatMetadir):
1846
 
    """Branch format with last-revision and tags.
1847
 
 
1848
 
    Unlike previous formats, this has no explicit revision history. Instead,
1849
 
    this just stores the last-revision, and the left-hand history leading
1850
 
    up to there is the history.
1851
 
 
1852
 
    This format was introduced in bzr 0.15
1853
 
    and became the default in 0.91.
1854
 
    """
1855
 
 
1856
 
    def _branch_class(self):
1857
 
        return BzrBranch6
1858
 
 
1859
 
    def get_format_string(self):
1860
 
        """See BranchFormat.get_format_string()."""
1861
 
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
1862
 
 
1863
 
    def get_format_description(self):
1864
 
        """See BranchFormat.get_format_description()."""
1865
 
        return "Branch format 6"
1866
 
 
1867
 
    def initialize(self, a_bzrdir):
1868
 
        """Create a branch of this format in a_bzrdir."""
1869
 
        utf8_files = [('last-revision', '0 null:\n'),
1870
 
                      ('branch.conf', ''),
1871
 
                      ('tags', ''),
1872
 
                      ]
1873
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1874
 
 
1875
 
    def make_tags(self, branch):
1876
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1877
 
        return BasicTags(branch)
1878
 
 
1879
 
    def supports_set_append_revisions_only(self):
1880
 
        return True
1881
 
 
1882
 
 
1883
 
class BzrBranchFormat8(BranchFormatMetadir):
1884
 
    """Metadir format supporting storing locations of subtree branches."""
1885
 
 
1886
 
    def _branch_class(self):
1887
 
        return BzrBranch8
1888
 
 
1889
 
    def get_format_string(self):
1890
 
        """See BranchFormat.get_format_string()."""
1891
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1892
 
 
1893
 
    def get_format_description(self):
1894
 
        """See BranchFormat.get_format_description()."""
1895
 
        return "Branch format 8"
1896
 
 
1897
 
    def initialize(self, a_bzrdir):
1898
 
        """Create a branch of this format in a_bzrdir."""
1899
 
        utf8_files = [('last-revision', '0 null:\n'),
1900
 
                      ('branch.conf', ''),
1901
 
                      ('tags', ''),
1902
 
                      ('references', '')
1903
 
                      ]
1904
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
708
        control_files = LockableFiles(branch_transport, 'lock', LockDir)
 
709
        control_files.create_lock()
 
710
        control_files.lock_write()
 
711
        control_files.put_utf8('format', self.get_format_string())
 
712
        try:
 
713
            for file, content in utf8_files:
 
714
                control_files.put_utf8(file, content)
 
715
        finally:
 
716
            control_files.unlock()
 
717
        return self.open(a_bzrdir, _found=True, )
1905
718
 
1906
719
    def __init__(self):
1907
 
        super(BzrBranchFormat8, self).__init__()
1908
 
        self._matchingbzrdir.repository_format = \
1909
 
            RepositoryFormatKnitPack5RichRoot()
1910
 
 
1911
 
    def make_tags(self, branch):
1912
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1913
 
        return BasicTags(branch)
1914
 
 
1915
 
    def supports_set_append_revisions_only(self):
1916
 
        return True
1917
 
 
1918
 
    def supports_stacking(self):
1919
 
        return True
1920
 
 
1921
 
    supports_reference_locations = True
1922
 
 
1923
 
 
1924
 
class BzrBranchFormat7(BzrBranchFormat8):
1925
 
    """Branch format with last-revision, tags, and a stacked location pointer.
1926
 
 
1927
 
    The stacked location pointer is passed down to the repository and requires
1928
 
    a repository format with supports_external_lookups = True.
1929
 
 
1930
 
    This format was introduced in bzr 1.6.
1931
 
    """
1932
 
 
1933
 
    def initialize(self, a_bzrdir):
1934
 
        """Create a branch of this format in a_bzrdir."""
1935
 
        utf8_files = [('last-revision', '0 null:\n'),
1936
 
                      ('branch.conf', ''),
1937
 
                      ('tags', ''),
1938
 
                      ]
1939
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1940
 
 
1941
 
    def _branch_class(self):
1942
 
        return BzrBranch7
1943
 
 
1944
 
    def get_format_string(self):
1945
 
        """See BranchFormat.get_format_string()."""
1946
 
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1947
 
 
1948
 
    def get_format_description(self):
1949
 
        """See BranchFormat.get_format_description()."""
1950
 
        return "Branch format 7"
1951
 
 
1952
 
    def supports_set_append_revisions_only(self):
1953
 
        return True
1954
 
 
1955
 
    supports_reference_locations = False
 
720
        super(BzrBranchFormat5, self).__init__()
 
721
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
722
 
 
723
    def open(self, a_bzrdir, _found=False):
 
724
        """Return the branch object for a_bzrdir
 
725
 
 
726
        _found is a private parameter, do not use it. It is used to indicate
 
727
               if format probing has already be done.
 
728
        """
 
729
        if not _found:
 
730
            format = BranchFormat.find_format(a_bzrdir)
 
731
            assert format.__class__ == self.__class__
 
732
        transport = a_bzrdir.get_branch_transport(None)
 
733
        control_files = LockableFiles(transport, 'lock', LockDir)
 
734
        return BzrBranch5(_format=self,
 
735
                          _control_files=control_files,
 
736
                          a_bzrdir=a_bzrdir,
 
737
                          _repository=a_bzrdir.find_repository())
 
738
 
 
739
    def __str__(self):
 
740
        return "Bazaar-NG Metadir branch format 5"
1956
741
 
1957
742
 
1958
743
class BranchReferenceFormat(BranchFormat):
1973
758
    def get_format_description(self):
1974
759
        """See BranchFormat.get_format_description()."""
1975
760
        return "Checkout reference format 1"
1976
 
 
1977
 
    def get_reference(self, a_bzrdir):
1978
 
        """See BranchFormat.get_reference()."""
1979
 
        transport = a_bzrdir.get_branch_transport(None)
1980
 
        return transport.get_bytes('location')
1981
 
 
1982
 
    def set_reference(self, a_bzrdir, to_branch):
1983
 
        """See BranchFormat.set_reference()."""
1984
 
        transport = a_bzrdir.get_branch_transport(None)
1985
 
        location = transport.put_bytes('location', to_branch.base)
1986
 
 
 
761
        
1987
762
    def initialize(self, a_bzrdir, target_branch=None):
1988
763
        """Create a branch of this format in a_bzrdir."""
1989
764
        if target_branch is None:
1992
767
            raise errors.UninitializableFormat(self)
1993
768
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1994
769
        branch_transport = a_bzrdir.get_branch_transport(self)
1995
 
        branch_transport.put_bytes('location',
1996
 
            target_branch.bzrdir.root_transport.base)
1997
 
        branch_transport.put_bytes('format', self.get_format_string())
1998
 
        return self.open(
1999
 
            a_bzrdir, _found=True,
2000
 
            possible_transports=[target_branch.bzrdir.root_transport])
 
770
        # FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
 
771
        branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
 
772
        branch_transport.put('format', StringIO(self.get_format_string()))
 
773
        return self.open(a_bzrdir, _found=True)
2001
774
 
2002
775
    def __init__(self):
2003
776
        super(BranchReferenceFormat, self).__init__()
2004
777
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2005
 
        self._matchingbzrdir.set_branch_format(self)
2006
778
 
2007
779
    def _make_reference_clone_function(format, a_branch):
2008
780
        """Create a clone() routine for a branch dynamically."""
2009
 
        def clone(to_bzrdir, revision_id=None,
2010
 
            repository_policy=None):
 
781
        def clone(to_bzrdir, revision_id=None):
2011
782
            """See Branch.clone()."""
2012
783
            return format.initialize(to_bzrdir, a_branch)
2013
784
            # cannot obey revision_id limits when cloning a reference ...
2015
786
            # emit some sort of warning/error to the caller ?!
2016
787
        return clone
2017
788
 
2018
 
    def open(self, a_bzrdir, _found=False, location=None,
2019
 
             possible_transports=None, ignore_fallbacks=False):
 
789
    def open(self, a_bzrdir, _found=False):
2020
790
        """Return the branch that the branch reference in a_bzrdir points at.
2021
791
 
2022
 
        :param a_bzrdir: A BzrDir that contains a branch.
2023
 
        :param _found: a private parameter, do not use it. It is used to
2024
 
            indicate if format probing has already be done.
2025
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2026
 
            (if there are any).  Default is to open fallbacks.
2027
 
        :param location: The location of the referenced branch.  If
2028
 
            unspecified, this will be determined from the branch reference in
2029
 
            a_bzrdir.
2030
 
        :param possible_transports: An optional reusable transports list.
 
792
        _found is a private parameter, do not use it. It is used to indicate
 
793
               if format probing has already be done.
2031
794
        """
2032
795
        if not _found:
2033
796
            format = BranchFormat.find_format(a_bzrdir)
2034
 
            if format.__class__ != self.__class__:
2035
 
                raise AssertionError("wrong format %r found for %r" %
2036
 
                    (format, self))
2037
 
        if location is None:
2038
 
            location = self.get_reference(a_bzrdir)
2039
 
        real_bzrdir = bzrdir.BzrDir.open(
2040
 
            location, possible_transports=possible_transports)
2041
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
797
            assert format.__class__ == self.__class__
 
798
        transport = a_bzrdir.get_branch_transport(None)
 
799
        real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
 
800
        result = real_bzrdir.open_branch()
2042
801
        # this changes the behaviour of result.clone to create a new reference
2043
802
        # rather than a copy of the content of the branch.
2044
803
        # I did not use a proxy object because that needs much more extensive
2051
810
        return result
2052
811
 
2053
812
 
2054
 
network_format_registry = registry.FormatRegistry()
2055
 
"""Registry of formats indexed by their network name.
2056
 
 
2057
 
The network name for a branch format is an identifier that can be used when
2058
 
referring to formats with smart server operations. See
2059
 
BranchFormat.network_name() for more detail.
2060
 
"""
2061
 
 
2062
 
 
2063
813
# formats which have no format string are not discoverable
2064
814
# and not independently creatable, so are not registered.
2065
 
__format5 = BzrBranchFormat5()
2066
 
__format6 = BzrBranchFormat6()
2067
 
__format7 = BzrBranchFormat7()
2068
 
__format8 = BzrBranchFormat8()
2069
 
BranchFormat.register_format(__format5)
 
815
__default_format = BzrBranchFormat5()
 
816
BranchFormat.register_format(__default_format)
2070
817
BranchFormat.register_format(BranchReferenceFormat())
2071
 
BranchFormat.register_format(__format6)
2072
 
BranchFormat.register_format(__format7)
2073
 
BranchFormat.register_format(__format8)
2074
 
BranchFormat.set_default_format(__format7)
 
818
BranchFormat.set_default_format(__default_format)
2075
819
_legacy_formats = [BzrBranchFormat4(),
2076
 
    ]
2077
 
network_format_registry.register(
2078
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2079
 
 
2080
 
 
2081
 
class BzrBranch(Branch, _RelockDebugMixin):
 
820
                   ]
 
821
 
 
822
class BzrBranch(Branch):
2082
823
    """A branch stored in the actual filesystem.
2083
824
 
2084
825
    Note that it's "local" in the context of the filesystem; it doesn't
2085
826
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
2086
827
    it's writable, and can be accessed via the normal filesystem API.
2087
 
 
2088
 
    :ivar _transport: Transport for file operations on this branch's
2089
 
        control files, typically pointing to the .bzr/branch directory.
2090
 
    :ivar repository: Repository for this branch.
2091
 
    :ivar base: The url of the base directory for this branch; the one
2092
 
        containing the .bzr directory.
2093
828
    """
2094
 
 
2095
 
    def __init__(self, _format=None,
2096
 
                 _control_files=None, a_bzrdir=None, _repository=None,
2097
 
                 ignore_fallbacks=False):
2098
 
        """Create new branch object at a particular location."""
 
829
    
 
830
    def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
 
831
                 relax_version_check=DEPRECATED_PARAMETER, _format=None,
 
832
                 _control_files=None, a_bzrdir=None, _repository=None):
 
833
        """Create new branch object at a particular location.
 
834
 
 
835
        transport -- A Transport object, defining how to access files.
 
836
        
 
837
        init -- If True, create new control files in a previously
 
838
             unversioned directory.  If False, the branch must already
 
839
             be versioned.
 
840
 
 
841
        relax_version_check -- If true, the usual check for the branch
 
842
            version is not applied.  This is intended only for
 
843
            upgrade/recovery type use; it's not guaranteed that
 
844
            all operations will work on old format branches.
 
845
        """
2099
846
        if a_bzrdir is None:
2100
 
            raise ValueError('a_bzrdir must be supplied')
 
847
            self.bzrdir = bzrdir.BzrDir.open(transport.base)
2101
848
        else:
2102
849
            self.bzrdir = a_bzrdir
2103
 
        self._base = self.bzrdir.transport.clone('..').base
2104
 
        # XXX: We should be able to just do
2105
 
        #   self.base = self.bzrdir.root_transport.base
2106
 
        # but this does not quite work yet -- mbp 20080522
 
850
        self._transport = self.bzrdir.transport.clone('..')
 
851
        self._base = self._transport.base
2107
852
        self._format = _format
2108
853
        if _control_files is None:
2109
 
            raise ValueError('BzrBranch _control_files is None')
 
854
            raise BzrBadParameterMissing('_control_files')
2110
855
        self.control_files = _control_files
2111
 
        self._transport = _control_files._transport
 
856
        if deprecated_passed(init):
 
857
            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
 
858
                 "deprecated as of bzr 0.8. Please use Branch.create().",
 
859
                 DeprecationWarning,
 
860
                 stacklevel=2)
 
861
            if init:
 
862
                # this is slower than before deprecation, oh well never mind.
 
863
                # -> its deprecated.
 
864
                self._initialize(transport.base)
 
865
        self._check_format(_format)
 
866
        if deprecated_passed(relax_version_check):
 
867
            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
 
868
                 "relax_version_check parameter is deprecated as of bzr 0.8. "
 
869
                 "Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
 
870
                 "open() method.",
 
871
                 DeprecationWarning,
 
872
                 stacklevel=2)
 
873
            if (not relax_version_check
 
874
                and not self._format.is_supported()):
 
875
                raise errors.UnsupportedFormatError(
 
876
                        'sorry, branch format %r not supported' % fmt,
 
877
                        ['use a different bzr version',
 
878
                         'or remove the .bzr directory'
 
879
                         ' and "bzr init" again'])
 
880
        if deprecated_passed(transport):
 
881
            warn("BzrBranch.__init__(transport=XXX...): The transport "
 
882
                 "parameter is deprecated as of bzr 0.8. "
 
883
                 "Please use Branch.open, or bzrdir.open_branch().",
 
884
                 DeprecationWarning,
 
885
                 stacklevel=2)
2112
886
        self.repository = _repository
2113
 
        Branch.__init__(self)
2114
887
 
2115
888
    def __str__(self):
2116
889
        return '%s(%r)' % (self.__class__.__name__, self.base)
2117
890
 
2118
891
    __repr__ = __str__
2119
892
 
 
893
    def __del__(self):
 
894
        # TODO: It might be best to do this somewhere else,
 
895
        # but it is nice for a Branch object to automatically
 
896
        # cache it's information.
 
897
        # Alternatively, we could have the Transport objects cache requests
 
898
        # See the earlier discussion about how major objects (like Branch)
 
899
        # should never expect their __del__ function to run.
 
900
        # XXX: cache_root seems to be unused, 2006-01-13 mbp
 
901
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
902
            try:
 
903
                rmtree(self.cache_root)
 
904
            except:
 
905
                pass
 
906
            self.cache_root = None
 
907
 
2120
908
    def _get_base(self):
2121
 
        """Returns the directory containing the control directory."""
2122
909
        return self._base
2123
910
 
2124
911
    base = property(_get_base, doc="The URL for the root of this branch.")
2125
912
 
2126
 
    def _get_config(self):
2127
 
        return TransportConfig(self._transport, 'branch.conf')
 
913
    def _finish_transaction(self):
 
914
        """Exit the current transaction."""
 
915
        return self.control_files._finish_transaction()
 
916
 
 
917
    def get_transaction(self):
 
918
        """Return the current active transaction.
 
919
 
 
920
        If no transaction is active, this returns a passthrough object
 
921
        for which all data is immediately flushed and no caching happens.
 
922
        """
 
923
        # this is an explicit function so that we can do tricky stuff
 
924
        # when the storage in rev_storage is elsewhere.
 
925
        # we probably need to hook the two 'lock a location' and 
 
926
        # 'have a transaction' together more delicately, so that
 
927
        # we can have two locks (branch and storage) and one transaction
 
928
        # ... and finishing the transaction unlocks both, but unlocking
 
929
        # does not. - RBC 20051121
 
930
        return self.control_files.get_transaction()
 
931
 
 
932
    def _set_transaction(self, transaction):
 
933
        """Set a new active transaction."""
 
934
        return self.control_files._set_transaction(transaction)
 
935
 
 
936
    def abspath(self, name):
 
937
        """See Branch.abspath."""
 
938
        return self.control_files._transport.abspath(name)
 
939
 
 
940
    def _check_format(self, format):
 
941
        """Identify the branch format if needed.
 
942
 
 
943
        The format is stored as a reference to the format object in
 
944
        self._format for code that needs to check it later.
 
945
 
 
946
        The format parameter is either None or the branch format class
 
947
        used to open this branch.
 
948
 
 
949
        FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
 
950
        """
 
951
        if format is None:
 
952
            format = BzrBranchFormat.find_format(self.bzrdir)
 
953
        self._format = format
 
954
        mutter("got branch format %s", self._format)
 
955
 
 
956
    @needs_read_lock
 
957
    def get_root_id(self):
 
958
        """See Branch.get_root_id."""
 
959
        tree = self.repository.revision_tree(self.last_revision())
 
960
        return tree.inventory.root.file_id
2128
961
 
2129
962
    def is_locked(self):
2130
963
        return self.control_files.is_locked()
2131
964
 
2132
 
    def lock_write(self, token=None):
2133
 
        if not self.is_locked():
2134
 
            self._note_lock('w')
2135
 
        # All-in-one needs to always unlock/lock.
2136
 
        repo_control = getattr(self.repository, 'control_files', None)
2137
 
        if self.control_files == repo_control or not self.is_locked():
2138
 
            self.repository._warn_if_deprecated(self)
2139
 
            self.repository.lock_write()
2140
 
            took_lock = True
2141
 
        else:
2142
 
            took_lock = False
2143
 
        try:
2144
 
            return self.control_files.lock_write(token=token)
2145
 
        except:
2146
 
            if took_lock:
2147
 
                self.repository.unlock()
2148
 
            raise
 
965
    def lock_write(self):
 
966
        # TODO: test for failed two phase locks. This is known broken.
 
967
        self.control_files.lock_write()
 
968
        self.repository.lock_write()
2149
969
 
2150
970
    def lock_read(self):
2151
 
        if not self.is_locked():
2152
 
            self._note_lock('r')
2153
 
        # All-in-one needs to always unlock/lock.
2154
 
        repo_control = getattr(self.repository, 'control_files', None)
2155
 
        if self.control_files == repo_control or not self.is_locked():
2156
 
            self.repository._warn_if_deprecated(self)
2157
 
            self.repository.lock_read()
2158
 
            took_lock = True
2159
 
        else:
2160
 
            took_lock = False
2161
 
        try:
2162
 
            self.control_files.lock_read()
2163
 
        except:
2164
 
            if took_lock:
2165
 
                self.repository.unlock()
2166
 
            raise
 
971
        # TODO: test for failed two phase locks. This is known broken.
 
972
        self.control_files.lock_read()
 
973
        self.repository.lock_read()
2167
974
 
2168
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2169
975
    def unlock(self):
 
976
        # TODO: test for failed two phase locks. This is known broken.
2170
977
        try:
 
978
            self.repository.unlock()
 
979
        finally:
2171
980
            self.control_files.unlock()
2172
 
        finally:
2173
 
            # All-in-one needs to always unlock/lock.
2174
 
            repo_control = getattr(self.repository, 'control_files', None)
2175
 
            if (self.control_files == repo_control or
2176
 
                not self.control_files.is_locked()):
2177
 
                self.repository.unlock()
2178
 
            if not self.control_files.is_locked():
2179
 
                # we just released the lock
2180
 
                self._clear_cached_state()
2181
 
 
 
981
        
2182
982
    def peek_lock_mode(self):
2183
983
        if self.control_files._lock_count == 0:
2184
984
            return None
2193
993
        """See Branch.print_file."""
2194
994
        return self.repository.print_file(file, revision_id)
2195
995
 
2196
 
    def _write_revision_history(self, history):
2197
 
        """Factored out of set_revision_history.
2198
 
 
2199
 
        This performs the actual writing to disk.
2200
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2201
 
        self._transport.put_bytes(
2202
 
            'revision-history', '\n'.join(history),
2203
 
            mode=self.bzrdir._get_file_mode())
 
996
    @needs_write_lock
 
997
    def append_revision(self, *revision_ids):
 
998
        """See Branch.append_revision."""
 
999
        for revision_id in revision_ids:
 
1000
            mutter("add {%s} to revision-history" % revision_id)
 
1001
        rev_history = self.revision_history()
 
1002
        rev_history.extend(revision_ids)
 
1003
        self.set_revision_history(rev_history)
2204
1004
 
2205
1005
    @needs_write_lock
2206
1006
    def set_revision_history(self, rev_history):
2207
1007
        """See Branch.set_revision_history."""
2208
 
        if 'evil' in debug.debug_flags:
2209
 
            mutter_callsite(3, "set_revision_history scales with history.")
2210
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2211
 
        for rev_id in rev_history:
2212
 
            check_not_reserved_id(rev_id)
2213
 
        if Branch.hooks['post_change_branch_tip']:
2214
 
            # Don't calculate the last_revision_info() if there are no hooks
2215
 
            # that will use it.
2216
 
            old_revno, old_revid = self.last_revision_info()
2217
 
        if len(rev_history) == 0:
2218
 
            revid = _mod_revision.NULL_REVISION
 
1008
        self.control_files.put_utf8(
 
1009
            'revision-history', '\n'.join(rev_history))
 
1010
        transaction = self.get_transaction()
 
1011
        history = transaction.map.find_revision_history()
 
1012
        if history is not None:
 
1013
            # update the revision history in the identity map.
 
1014
            history[:] = list(rev_history)
 
1015
            # this call is disabled because revision_history is 
 
1016
            # not really an object yet, and the transaction is for objects.
 
1017
            # transaction.register_dirty(history)
2219
1018
        else:
2220
 
            revid = rev_history[-1]
2221
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2222
 
        self._write_revision_history(rev_history)
2223
 
        self._clear_cached_state()
2224
 
        self._cache_revision_history(rev_history)
2225
 
        for hook in Branch.hooks['set_rh']:
2226
 
            hook(self, rev_history)
2227
 
        if Branch.hooks['post_change_branch_tip']:
2228
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2229
 
 
2230
 
    def _synchronize_history(self, destination, revision_id):
2231
 
        """Synchronize last revision and revision history between branches.
2232
 
 
2233
 
        This version is most efficient when the destination is also a
2234
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2235
 
        history is the true lefthand parent history, and all of the revisions
2236
 
        are in the destination's repository.  If not, set_revision_history
2237
 
        will fail.
2238
 
 
2239
 
        :param destination: The branch to copy the history into
2240
 
        :param revision_id: The revision-id to truncate history at.  May
2241
 
          be None to copy complete history.
 
1019
            transaction.map.add_revision_history(rev_history)
 
1020
            # this call is disabled because revision_history is 
 
1021
            # not really an object yet, and the transaction is for objects.
 
1022
            # transaction.register_clean(history)
 
1023
 
 
1024
    def get_revision_delta(self, revno):
 
1025
        """Return the delta for one revision.
 
1026
 
 
1027
        The delta is relative to its mainline predecessor, or the
 
1028
        empty tree for revision 1.
2242
1029
        """
2243
 
        if not isinstance(destination._format, BzrBranchFormat5):
2244
 
            super(BzrBranch, self)._synchronize_history(
2245
 
                destination, revision_id)
2246
 
            return
2247
 
        if revision_id == _mod_revision.NULL_REVISION:
 
1030
        assert isinstance(revno, int)
 
1031
        rh = self.revision_history()
 
1032
        if not (1 <= revno <= len(rh)):
 
1033
            raise InvalidRevisionNumber(revno)
 
1034
 
 
1035
        # revno is 1-based; list is 0-based
 
1036
 
 
1037
        new_tree = self.repository.revision_tree(rh[revno-1])
 
1038
        if revno == 1:
 
1039
            old_tree = EmptyTree()
 
1040
        else:
 
1041
            old_tree = self.repository.revision_tree(rh[revno-2])
 
1042
        return compare_trees(old_tree, new_tree)
 
1043
 
 
1044
    @needs_read_lock
 
1045
    def revision_history(self):
 
1046
        """See Branch.revision_history."""
 
1047
        transaction = self.get_transaction()
 
1048
        history = transaction.map.find_revision_history()
 
1049
        if history is not None:
 
1050
            mutter("cache hit for revision-history in %s", self)
 
1051
            return list(history)
 
1052
        history = [l.rstrip('\r\n') for l in
 
1053
                self.control_files.get_utf8('revision-history').readlines()]
 
1054
        transaction.map.add_revision_history(history)
 
1055
        # this call is disabled because revision_history is 
 
1056
        # not really an object yet, and the transaction is for objects.
 
1057
        # transaction.register_clean(history, precious=True)
 
1058
        return list(history)
 
1059
 
 
1060
    @needs_write_lock
 
1061
    def update_revisions(self, other, stop_revision=None):
 
1062
        """See Branch.update_revisions."""
 
1063
        other.lock_read()
 
1064
        try:
 
1065
            if stop_revision is None:
 
1066
                stop_revision = other.last_revision()
 
1067
                if stop_revision is None:
 
1068
                    # if there are no commits, we're done.
 
1069
                    return
 
1070
            # whats the current last revision, before we fetch [and change it
 
1071
            # possibly]
 
1072
            last_rev = self.last_revision()
 
1073
            # we fetch here regardless of whether we need to so that we pickup
 
1074
            # filled in ghosts.
 
1075
            self.fetch(other, stop_revision)
 
1076
            my_ancestry = self.repository.get_ancestry(last_rev)
 
1077
            if stop_revision in my_ancestry:
 
1078
                # last_revision is a descendant of stop_revision
 
1079
                return
 
1080
            # stop_revision must be a descendant of last_revision
 
1081
            stop_graph = self.repository.get_revision_graph(stop_revision)
 
1082
            if last_rev is not None and last_rev not in stop_graph:
 
1083
                # our previous tip is not merged into stop_revision
 
1084
                raise errors.DivergedBranches(self, other)
 
1085
            # make a new revision history from the graph
 
1086
            current_rev_id = stop_revision
2248
1087
            new_history = []
2249
 
        else:
2250
 
            new_history = self.revision_history()
2251
 
        if revision_id is not None and new_history != []:
2252
 
            try:
2253
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2254
 
            except ValueError:
2255
 
                rev = self.repository.get_revision(revision_id)
2256
 
                new_history = rev.get_history(self.repository)[1:]
2257
 
        destination.set_revision_history(new_history)
2258
 
 
2259
 
    @needs_write_lock
2260
 
    def set_last_revision_info(self, revno, revision_id):
2261
 
        """Set the last revision of this branch.
2262
 
 
2263
 
        The caller is responsible for checking that the revno is correct
2264
 
        for this revision id.
2265
 
 
2266
 
        It may be possible to set the branch last revision to an id not
2267
 
        present in the repository.  However, branches can also be
2268
 
        configured to check constraints on history, in which case this may not
2269
 
        be permitted.
2270
 
        """
2271
 
        revision_id = _mod_revision.ensure_null(revision_id)
2272
 
        # this old format stores the full history, but this api doesn't
2273
 
        # provide it, so we must generate, and might as well check it's
2274
 
        # correct
2275
 
        history = self._lefthand_history(revision_id)
2276
 
        if len(history) != revno:
2277
 
            raise AssertionError('%d != %d' % (len(history), revno))
2278
 
        self.set_revision_history(history)
2279
 
 
2280
 
    def _gen_revision_history(self):
2281
 
        history = self._transport.get_bytes('revision-history').split('\n')
2282
 
        if history[-1:] == ['']:
2283
 
            # There shouldn't be a trailing newline, but just in case.
2284
 
            history.pop()
2285
 
        return history
2286
 
 
2287
 
    @needs_write_lock
2288
 
    def generate_revision_history(self, revision_id, last_rev=None,
2289
 
        other_branch=None):
2290
 
        """Create a new revision history that will finish with revision_id.
2291
 
 
2292
 
        :param revision_id: the new tip to use.
2293
 
        :param last_rev: The previous last_revision. If not None, then this
2294
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2295
 
        :param other_branch: The other branch that DivergedBranches should
2296
 
            raise with respect to.
2297
 
        """
2298
 
        self.set_revision_history(self._lefthand_history(revision_id,
2299
 
            last_rev, other_branch))
 
1088
            while current_rev_id not in (None, NULL_REVISION):
 
1089
                new_history.append(current_rev_id)
 
1090
                current_rev_id_parents = stop_graph[current_rev_id]
 
1091
                try:
 
1092
                    current_rev_id = current_rev_id_parents[0]
 
1093
                except IndexError:
 
1094
                    current_rev_id = None
 
1095
            new_history.reverse()
 
1096
            self.set_revision_history(new_history)
 
1097
        finally:
 
1098
            other.unlock()
2300
1099
 
2301
1100
    def basis_tree(self):
2302
1101
        """See Branch.basis_tree."""
2303
1102
        return self.repository.revision_tree(self.last_revision())
2304
1103
 
2305
 
    def _get_parent_location(self):
 
1104
    @deprecated_method(zero_eight)
 
1105
    def working_tree(self):
 
1106
        """Create a Working tree object for this branch."""
 
1107
        from bzrlib.workingtree import WorkingTree
 
1108
        from bzrlib.transport.local import LocalTransport
 
1109
        if (self.base.find('://') != -1 or 
 
1110
            not isinstance(self._transport, LocalTransport)):
 
1111
            raise NoWorkingTree(self.base)
 
1112
        return self.bzrdir.open_workingtree()
 
1113
 
 
1114
    @needs_write_lock
 
1115
    def pull(self, source, overwrite=False, stop_revision=None):
 
1116
        """See Branch.pull."""
 
1117
        source.lock_read()
 
1118
        try:
 
1119
            old_count = len(self.revision_history())
 
1120
            try:
 
1121
                self.update_revisions(source,stop_revision)
 
1122
            except DivergedBranches:
 
1123
                if not overwrite:
 
1124
                    raise
 
1125
            if overwrite:
 
1126
                self.set_revision_history(source.revision_history())
 
1127
            new_count = len(self.revision_history())
 
1128
            return new_count - old_count
 
1129
        finally:
 
1130
            source.unlock()
 
1131
 
 
1132
    def get_parent(self):
 
1133
        """See Branch.get_parent."""
 
1134
        import errno
2306
1135
        _locs = ['parent', 'pull', 'x-pull']
2307
1136
        for l in _locs:
2308
1137
            try:
2309
 
                return self._transport.get_bytes(l).strip('\n')
2310
 
            except errors.NoSuchFile:
 
1138
                return self.control_files.get_utf8(l).read().strip('\n')
 
1139
            except NoSuchFile:
2311
1140
                pass
2312
1141
        return None
2313
1142
 
2314
 
    def _basic_push(self, target, overwrite, stop_revision):
2315
 
        """Basic implementation of push without bound branches or hooks.
2316
 
 
2317
 
        Must be called with source read locked and target write locked.
2318
 
        """
2319
 
        result = BranchPushResult()
2320
 
        result.source_branch = self
2321
 
        result.target_branch = target
2322
 
        result.old_revno, result.old_revid = target.last_revision_info()
2323
 
        self.update_references(target)
2324
 
        if result.old_revid != self.last_revision():
2325
 
            # We assume that during 'push' this repository is closer than
2326
 
            # the target.
2327
 
            graph = self.repository.get_graph(target.repository)
2328
 
            target.update_revisions(self, stop_revision,
2329
 
                overwrite=overwrite, graph=graph)
2330
 
        if self._push_should_merge_tags():
2331
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2332
 
                overwrite)
2333
 
        result.new_revno, result.new_revid = target.last_revision_info()
2334
 
        return result
2335
 
 
2336
 
    def get_stacked_on_url(self):
2337
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1143
    def get_push_location(self):
 
1144
        """See Branch.get_push_location."""
 
1145
        config = bzrlib.config.BranchConfig(self)
 
1146
        push_loc = config.get_user_option('push_location')
 
1147
        return push_loc
2338
1148
 
2339
1149
    def set_push_location(self, location):
2340
1150
        """See Branch.set_push_location."""
2341
 
        self.get_config().set_user_option(
2342
 
            'push_location', location,
2343
 
            store=_mod_config.STORE_LOCATION_NORECURSE)
 
1151
        config = bzrlib.config.LocationConfig(self.base)
 
1152
        config.set_user_option('push_location', location)
2344
1153
 
2345
 
    def _set_parent_location(self, url):
 
1154
    @needs_write_lock
 
1155
    def set_parent(self, url):
 
1156
        """See Branch.set_parent."""
 
1157
        # TODO: Maybe delete old location files?
 
1158
        # URLs should never be unicode, even on the local fs,
 
1159
        # FIXUP this and get_parent in a future branch format bump:
 
1160
        # read and rewrite the file, and have the new format code read
 
1161
        # using .get not .get_utf8. RBC 20060125
2346
1162
        if url is None:
2347
 
            self._transport.delete('parent')
 
1163
            self.control_files._transport.delete('parent')
2348
1164
        else:
2349
 
            self._transport.put_bytes('parent', url + '\n',
2350
 
                mode=self.bzrdir._get_file_mode())
 
1165
            self.control_files.put_utf8('parent', url + '\n')
 
1166
 
 
1167
    def tree_config(self):
 
1168
        return TreeConfig(self)
2351
1169
 
2352
1170
 
2353
1171
class BzrBranch5(BzrBranch):
2354
 
    """A format 5 branch. This supports new features over plain branches.
 
1172
    """A format 5 branch. This supports new features over plan branches.
2355
1173
 
2356
1174
    It has support for a master_branch which is the data for bound branches.
2357
1175
    """
2358
1176
 
 
1177
    def __init__(self,
 
1178
                 _format,
 
1179
                 _control_files,
 
1180
                 a_bzrdir,
 
1181
                 _repository):
 
1182
        super(BzrBranch5, self).__init__(_format=_format,
 
1183
                                         _control_files=_control_files,
 
1184
                                         a_bzrdir=a_bzrdir,
 
1185
                                         _repository=_repository)
 
1186
        
 
1187
    @needs_write_lock
 
1188
    def pull(self, source, overwrite=False, stop_revision=None):
 
1189
        """Updates branch.pull to be bound branch aware."""
 
1190
        bound_location = self.get_bound_location()
 
1191
        if source.base != bound_location:
 
1192
            # not pulling from master, so we need to update master.
 
1193
            master_branch = self.get_master_branch()
 
1194
            if master_branch:
 
1195
                master_branch.pull(source)
 
1196
                source = master_branch
 
1197
        return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
 
1198
 
2359
1199
    def get_bound_location(self):
2360
1200
        try:
2361
 
            return self._transport.get_bytes('bound')[:-1]
 
1201
            return self.control_files.get_utf8('bound').read()[:-1]
2362
1202
        except errors.NoSuchFile:
2363
1203
            return None
2364
1204
 
2365
1205
    @needs_read_lock
2366
 
    def get_master_branch(self, possible_transports=None):
 
1206
    def get_master_branch(self):
2367
1207
        """Return the branch we are bound to.
2368
 
 
 
1208
        
2369
1209
        :return: Either a Branch, or None
2370
1210
 
2371
1211
        This could memoise the branch, but if thats done
2372
1212
        it must be revalidated on each new lock.
2373
 
        So for now we just don't memoise it.
 
1213
        So for now we just dont memoise it.
2374
1214
        # RBC 20060304 review this decision.
2375
1215
        """
2376
1216
        bound_loc = self.get_bound_location()
2377
1217
        if not bound_loc:
2378
1218
            return None
2379
1219
        try:
2380
 
            return Branch.open(bound_loc,
2381
 
                               possible_transports=possible_transports)
 
1220
            return Branch.open(bound_loc)
2382
1221
        except (errors.NotBranchError, errors.ConnectionError), e:
2383
1222
            raise errors.BoundBranchConnectionFailure(
2384
1223
                    self, bound_loc, e)
2390
1229
        :param location: URL to the target branch
2391
1230
        """
2392
1231
        if location:
2393
 
            self._transport.put_bytes('bound', location+'\n',
2394
 
                mode=self.bzrdir._get_file_mode())
 
1232
            self.control_files.put_utf8('bound', location+'\n')
2395
1233
        else:
2396
1234
            try:
2397
 
                self._transport.delete('bound')
2398
 
            except errors.NoSuchFile:
 
1235
                self.control_files._transport.delete('bound')
 
1236
            except NoSuchFile:
2399
1237
                return False
2400
1238
            return True
2401
1239
 
2402
1240
    @needs_write_lock
2403
1241
    def bind(self, other):
2404
 
        """Bind this branch to the branch other.
2405
 
 
2406
 
        This does not push or pull data between the branches, though it does
2407
 
        check for divergence to raise an error when the branches are not
2408
 
        either the same, or one a prefix of the other. That behaviour may not
2409
 
        be useful, so that check may be removed in future.
 
1242
        """Bind the local branch the other branch.
2410
1243
 
2411
1244
        :param other: The branch to bind to
2412
1245
        :type other: Branch
2418
1251
        #       but binding itself may not be.
2419
1252
        #       Since we *have* to check at commit time, we don't
2420
1253
        #       *need* to check here
2421
 
 
2422
 
        # we want to raise diverged if:
2423
 
        # last_rev is not in the other_last_rev history, AND
2424
 
        # other_last_rev is not in our history, and do it without pulling
2425
 
        # history around
 
1254
        self.pull(other)
 
1255
 
 
1256
        # we are now equal to or a suffix of other.
 
1257
 
 
1258
        # Since we have 'pulled' from the remote location,
 
1259
        # now we should try to pull in the opposite direction
 
1260
        # in case the local tree has more revisions than the
 
1261
        # remote one.
 
1262
        # There may be a different check you could do here
 
1263
        # rather than actually trying to install revisions remotely.
 
1264
        # TODO: capture an exception which indicates the remote branch
 
1265
        #       is not writeable. 
 
1266
        #       If it is up-to-date, this probably should not be a failure
 
1267
        
 
1268
        # lock other for write so the revision-history syncing cannot race
 
1269
        other.lock_write()
 
1270
        try:
 
1271
            other.pull(self)
 
1272
            # if this does not error, other now has the same last rev we do
 
1273
            # it can only error if the pull from other was concurrent with
 
1274
            # a commit to other from someone else.
 
1275
 
 
1276
            # until we ditch revision-history, we need to sync them up:
 
1277
            self.set_revision_history(other.revision_history())
 
1278
            # now other and self are up to date with each other and have the
 
1279
            # same revision-history.
 
1280
        finally:
 
1281
            other.unlock()
 
1282
 
2426
1283
        self.set_bound_location(other.base)
2427
1284
 
2428
1285
    @needs_write_lock
2431
1288
        return self.set_bound_location(None)
2432
1289
 
2433
1290
    @needs_write_lock
2434
 
    def update(self, possible_transports=None):
2435
 
        """Synchronise this branch with the master branch if any.
 
1291
    def update(self):
 
1292
        """Synchronise this branch with the master branch if any. 
2436
1293
 
2437
1294
        :return: None or the last_revision that was pivoted out during the
2438
1295
                 update.
2439
1296
        """
2440
 
        master = self.get_master_branch(possible_transports)
 
1297
        master = self.get_master_branch()
2441
1298
        if master is not None:
2442
 
            old_tip = _mod_revision.ensure_null(self.last_revision())
 
1299
            old_tip = self.last_revision()
2443
1300
            self.pull(master, overwrite=True)
2444
 
            if self.repository.get_graph().is_ancestor(old_tip,
2445
 
                _mod_revision.ensure_null(self.last_revision())):
 
1301
            if old_tip in self.repository.get_ancestry(self.last_revision()):
2446
1302
                return None
2447
1303
            return old_tip
2448
1304
        return None
2449
1305
 
2450
1306
 
2451
 
class BzrBranch8(BzrBranch5):
2452
 
    """A branch that stores tree-reference locations."""
2453
 
 
2454
 
    def _open_hook(self):
2455
 
        if self._ignore_fallbacks:
2456
 
            return
2457
 
        try:
2458
 
            url = self.get_stacked_on_url()
2459
 
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2460
 
            errors.UnstackableBranchFormat):
2461
 
            pass
2462
 
        else:
2463
 
            for hook in Branch.hooks['transform_fallback_location']:
2464
 
                url = hook(self, url)
2465
 
                if url is None:
2466
 
                    hook_name = Branch.hooks.get_hook_name(hook)
2467
 
                    raise AssertionError(
2468
 
                        "'transform_fallback_location' hook %s returned "
2469
 
                        "None, not a URL." % hook_name)
2470
 
            self._activate_fallback_location(url)
2471
 
 
2472
 
    def __init__(self, *args, **kwargs):
2473
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2474
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
2475
 
        self._last_revision_info_cache = None
2476
 
        self._reference_info = None
2477
 
 
2478
 
    def _clear_cached_state(self):
2479
 
        super(BzrBranch8, self)._clear_cached_state()
2480
 
        self._last_revision_info_cache = None
2481
 
        self._reference_info = None
2482
 
 
2483
 
    def _last_revision_info(self):
2484
 
        revision_string = self._transport.get_bytes('last-revision')
2485
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2486
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2487
 
        revno = int(revno)
2488
 
        return revno, revision_id
2489
 
 
2490
 
    def _write_last_revision_info(self, revno, revision_id):
2491
 
        """Simply write out the revision id, with no checks.
2492
 
 
2493
 
        Use set_last_revision_info to perform this safely.
2494
 
 
2495
 
        Does not update the revision_history cache.
2496
 
        Intended to be called by set_last_revision_info and
2497
 
        _write_revision_history.
2498
 
        """
2499
 
        revision_id = _mod_revision.ensure_null(revision_id)
2500
 
        out_string = '%d %s\n' % (revno, revision_id)
2501
 
        self._transport.put_bytes('last-revision', out_string,
2502
 
            mode=self.bzrdir._get_file_mode())
2503
 
 
2504
 
    @needs_write_lock
2505
 
    def set_last_revision_info(self, revno, revision_id):
2506
 
        revision_id = _mod_revision.ensure_null(revision_id)
2507
 
        old_revno, old_revid = self.last_revision_info()
2508
 
        if self._get_append_revisions_only():
2509
 
            self._check_history_violation(revision_id)
2510
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2511
 
        self._write_last_revision_info(revno, revision_id)
2512
 
        self._clear_cached_state()
2513
 
        self._last_revision_info_cache = revno, revision_id
2514
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2515
 
 
2516
 
    def _synchronize_history(self, destination, revision_id):
2517
 
        """Synchronize last revision and revision history between branches.
2518
 
 
2519
 
        :see: Branch._synchronize_history
2520
 
        """
2521
 
        # XXX: The base Branch has a fast implementation of this method based
2522
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2523
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2524
 
        # but wants the fast implementation, so it calls
2525
 
        # Branch._synchronize_history directly.
2526
 
        Branch._synchronize_history(self, destination, revision_id)
2527
 
 
2528
 
    def _check_history_violation(self, revision_id):
2529
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
2530
 
        if _mod_revision.is_null(last_revision):
2531
 
            return
2532
 
        if last_revision not in self._lefthand_history(revision_id):
2533
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
2534
 
 
2535
 
    def _gen_revision_history(self):
2536
 
        """Generate the revision history from last revision
2537
 
        """
2538
 
        last_revno, last_revision = self.last_revision_info()
2539
 
        self._extend_partial_history(stop_index=last_revno-1)
2540
 
        return list(reversed(self._partial_revision_history_cache))
2541
 
 
2542
 
    def _write_revision_history(self, history):
2543
 
        """Factored out of set_revision_history.
2544
 
 
2545
 
        This performs the actual writing to disk, with format-specific checks.
2546
 
        It is intended to be called by BzrBranch5.set_revision_history.
2547
 
        """
2548
 
        if len(history) == 0:
2549
 
            last_revision = 'null:'
2550
 
        else:
2551
 
            if history != self._lefthand_history(history[-1]):
2552
 
                raise errors.NotLefthandHistory(history)
2553
 
            last_revision = history[-1]
2554
 
        if self._get_append_revisions_only():
2555
 
            self._check_history_violation(last_revision)
2556
 
        self._write_last_revision_info(len(history), last_revision)
2557
 
 
2558
 
    @needs_write_lock
2559
 
    def _set_parent_location(self, url):
2560
 
        """Set the parent branch"""
2561
 
        self._set_config_location('parent_location', url, make_relative=True)
2562
 
 
2563
 
    @needs_read_lock
2564
 
    def _get_parent_location(self):
2565
 
        """Set the parent branch"""
2566
 
        return self._get_config_location('parent_location')
2567
 
 
2568
 
    @needs_write_lock
2569
 
    def _set_all_reference_info(self, info_dict):
2570
 
        """Replace all reference info stored in a branch.
2571
 
 
2572
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2573
 
        """
2574
 
        s = StringIO()
2575
 
        writer = rio.RioWriter(s)
2576
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2577
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2578
 
                                branch_location=branch_location)
2579
 
            writer.write_stanza(stanza)
2580
 
        self._transport.put_bytes('references', s.getvalue())
2581
 
        self._reference_info = info_dict
2582
 
 
2583
 
    @needs_read_lock
2584
 
    def _get_all_reference_info(self):
2585
 
        """Return all the reference info stored in a branch.
2586
 
 
2587
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2588
 
        """
2589
 
        if self._reference_info is not None:
2590
 
            return self._reference_info
2591
 
        rio_file = self._transport.get('references')
2592
 
        try:
2593
 
            stanzas = rio.read_stanzas(rio_file)
2594
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2595
 
                             s['branch_location'])) for s in stanzas)
2596
 
        finally:
2597
 
            rio_file.close()
2598
 
        self._reference_info = info_dict
2599
 
        return info_dict
2600
 
 
2601
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2602
 
        """Set the branch location to use for a tree reference.
2603
 
 
2604
 
        :param file_id: The file-id of the tree reference.
2605
 
        :param tree_path: The path of the tree reference in the tree.
2606
 
        :param branch_location: The location of the branch to retrieve tree
2607
 
            references from.
2608
 
        """
2609
 
        info_dict = self._get_all_reference_info()
2610
 
        info_dict[file_id] = (tree_path, branch_location)
2611
 
        if None in (tree_path, branch_location):
2612
 
            if tree_path is not None:
2613
 
                raise ValueError('tree_path must be None when branch_location'
2614
 
                                 ' is None.')
2615
 
            if branch_location is not None:
2616
 
                raise ValueError('branch_location must be None when tree_path'
2617
 
                                 ' is None.')
2618
 
            del info_dict[file_id]
2619
 
        self._set_all_reference_info(info_dict)
2620
 
 
2621
 
    def get_reference_info(self, file_id):
2622
 
        """Get the tree_path and branch_location for a tree reference.
2623
 
 
2624
 
        :return: a tuple of (tree_path, branch_location)
2625
 
        """
2626
 
        return self._get_all_reference_info().get(file_id, (None, None))
2627
 
 
2628
 
    def reference_parent(self, file_id, path, possible_transports=None):
2629
 
        """Return the parent branch for a tree-reference file_id.
2630
 
 
2631
 
        :param file_id: The file_id of the tree reference
2632
 
        :param path: The path of the file_id in the tree
2633
 
        :return: A branch associated with the file_id
2634
 
        """
2635
 
        branch_location = self.get_reference_info(file_id)[1]
2636
 
        if branch_location is None:
2637
 
            return Branch.reference_parent(self, file_id, path,
2638
 
                                           possible_transports)
2639
 
        branch_location = urlutils.join(self.base, branch_location)
2640
 
        return Branch.open(branch_location,
2641
 
                           possible_transports=possible_transports)
2642
 
 
2643
 
    def set_push_location(self, location):
2644
 
        """See Branch.set_push_location."""
2645
 
        self._set_config_location('push_location', location)
2646
 
 
2647
 
    def set_bound_location(self, location):
2648
 
        """See Branch.set_push_location."""
2649
 
        result = None
2650
 
        config = self.get_config()
2651
 
        if location is None:
2652
 
            if config.get_user_option('bound') != 'True':
2653
 
                return False
2654
 
            else:
2655
 
                config.set_user_option('bound', 'False', warn_masked=True)
2656
 
                return True
2657
 
        else:
2658
 
            self._set_config_location('bound_location', location,
2659
 
                                      config=config)
2660
 
            config.set_user_option('bound', 'True', warn_masked=True)
2661
 
        return True
2662
 
 
2663
 
    def _get_bound_location(self, bound):
2664
 
        """Return the bound location in the config file.
2665
 
 
2666
 
        Return None if the bound parameter does not match"""
2667
 
        config = self.get_config()
2668
 
        config_bound = (config.get_user_option('bound') == 'True')
2669
 
        if config_bound != bound:
2670
 
            return None
2671
 
        return self._get_config_location('bound_location', config=config)
2672
 
 
2673
 
    def get_bound_location(self):
2674
 
        """See Branch.set_push_location."""
2675
 
        return self._get_bound_location(True)
2676
 
 
2677
 
    def get_old_bound_location(self):
2678
 
        """See Branch.get_old_bound_location"""
2679
 
        return self._get_bound_location(False)
2680
 
 
2681
 
    def get_stacked_on_url(self):
2682
 
        # you can always ask for the URL; but you might not be able to use it
2683
 
        # if the repo can't support stacking.
2684
 
        ## self._check_stackable_repo()
2685
 
        stacked_url = self._get_config_location('stacked_on_location')
2686
 
        if stacked_url is None:
2687
 
            raise errors.NotStacked(self)
2688
 
        return stacked_url
2689
 
 
2690
 
    def _get_append_revisions_only(self):
2691
 
        value = self.get_config().get_user_option('append_revisions_only')
2692
 
        return value == 'True'
2693
 
 
2694
 
    @needs_write_lock
2695
 
    def generate_revision_history(self, revision_id, last_rev=None,
2696
 
                                  other_branch=None):
2697
 
        """See BzrBranch5.generate_revision_history"""
2698
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2699
 
        revno = len(history)
2700
 
        self.set_last_revision_info(revno, revision_id)
2701
 
 
2702
 
    @needs_read_lock
2703
 
    def get_rev_id(self, revno, history=None):
2704
 
        """Find the revision id of the specified revno."""
2705
 
        if revno == 0:
2706
 
            return _mod_revision.NULL_REVISION
2707
 
 
2708
 
        last_revno, last_revision_id = self.last_revision_info()
2709
 
        if revno <= 0 or revno > last_revno:
2710
 
            raise errors.NoSuchRevision(self, revno)
2711
 
 
2712
 
        if history is not None:
2713
 
            return history[revno - 1]
2714
 
 
2715
 
        index = last_revno - revno
2716
 
        if len(self._partial_revision_history_cache) <= index:
2717
 
            self._extend_partial_history(stop_index=index)
2718
 
        if len(self._partial_revision_history_cache) > index:
2719
 
            return self._partial_revision_history_cache[index]
2720
 
        else:
2721
 
            raise errors.NoSuchRevision(self, revno)
2722
 
 
2723
 
    @needs_read_lock
2724
 
    def revision_id_to_revno(self, revision_id):
2725
 
        """Given a revision id, return its revno"""
2726
 
        if _mod_revision.is_null(revision_id):
2727
 
            return 0
2728
 
        try:
2729
 
            index = self._partial_revision_history_cache.index(revision_id)
2730
 
        except ValueError:
2731
 
            self._extend_partial_history(stop_revision=revision_id)
2732
 
            index = len(self._partial_revision_history_cache) - 1
2733
 
            if self._partial_revision_history_cache[index] != revision_id:
2734
 
                raise errors.NoSuchRevision(self, revision_id)
2735
 
        return self.revno() - index
2736
 
 
2737
 
 
2738
 
class BzrBranch7(BzrBranch8):
2739
 
    """A branch with support for a fallback repository."""
2740
 
 
2741
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2742
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2743
 
 
2744
 
    def get_reference_info(self, file_id):
2745
 
        Branch.get_reference_info(self, file_id)
2746
 
 
2747
 
    def reference_parent(self, file_id, path, possible_transports=None):
2748
 
        return Branch.reference_parent(self, file_id, path,
2749
 
                                       possible_transports)
2750
 
 
2751
 
 
2752
 
class BzrBranch6(BzrBranch7):
2753
 
    """See BzrBranchFormat6 for the capabilities of this branch.
2754
 
 
2755
 
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2756
 
    i.e. stacking.
 
1307
class BranchTestProviderAdapter(object):
 
1308
    """A tool to generate a suite testing multiple branch formats at once.
 
1309
 
 
1310
    This is done by copying the test once for each transport and injecting
 
1311
    the transport_server, transport_readonly_server, and branch_format
 
1312
    classes into each copy. Each copy is also given a new id() to make it
 
1313
    easy to identify.
2757
1314
    """
2758
1315
 
2759
 
    def get_stacked_on_url(self):
2760
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1316
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1317
        self._transport_server = transport_server
 
1318
        self._transport_readonly_server = transport_readonly_server
 
1319
        self._formats = formats
 
1320
    
 
1321
    def adapt(self, test):
 
1322
        result = TestSuite()
 
1323
        for branch_format, bzrdir_format in self._formats:
 
1324
            new_test = deepcopy(test)
 
1325
            new_test.transport_server = self._transport_server
 
1326
            new_test.transport_readonly_server = self._transport_readonly_server
 
1327
            new_test.bzrdir_format = bzrdir_format
 
1328
            new_test.branch_format = branch_format
 
1329
            def make_new_test_id():
 
1330
                new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
 
1331
                return lambda: new_id
 
1332
            new_test.id = make_new_test_id()
 
1333
            result.addTest(new_test)
 
1334
        return result
2761
1335
 
2762
1336
 
2763
1337
######################################################################
2764
 
# results of operations
2765
 
 
2766
 
 
2767
 
class _Result(object):
2768
 
 
2769
 
    def _show_tag_conficts(self, to_file):
2770
 
        if not getattr(self, 'tag_conflicts', None):
2771
 
            return
2772
 
        to_file.write('Conflicting tags:\n')
2773
 
        for name, value1, value2 in self.tag_conflicts:
2774
 
            to_file.write('    %s\n' % (name, ))
2775
 
 
2776
 
 
2777
 
class PullResult(_Result):
2778
 
    """Result of a Branch.pull operation.
2779
 
 
2780
 
    :ivar old_revno: Revision number before pull.
2781
 
    :ivar new_revno: Revision number after pull.
2782
 
    :ivar old_revid: Tip revision id before pull.
2783
 
    :ivar new_revid: Tip revision id after pull.
2784
 
    :ivar source_branch: Source (local) branch object. (read locked)
2785
 
    :ivar master_branch: Master branch of the target, or the target if no
2786
 
        Master
2787
 
    :ivar local_branch: target branch if there is a Master, else None
2788
 
    :ivar target_branch: Target/destination branch object. (write locked)
2789
 
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2790
 
    """
2791
 
 
2792
 
    def __int__(self):
2793
 
        # DEPRECATED: pull used to return the change in revno
2794
 
        return self.new_revno - self.old_revno
2795
 
 
2796
 
    def report(self, to_file):
2797
 
        if not is_quiet():
2798
 
            if self.old_revid == self.new_revid:
2799
 
                to_file.write('No revisions to pull.\n')
2800
 
            else:
2801
 
                to_file.write('Now on revision %d.\n' % self.new_revno)
2802
 
        self._show_tag_conficts(to_file)
2803
 
 
2804
 
 
2805
 
class BranchPushResult(_Result):
2806
 
    """Result of a Branch.push operation.
2807
 
 
2808
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
2809
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
2810
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2811
 
        before the push.
2812
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2813
 
        after the push.
2814
 
    :ivar source_branch: Source branch object that the push was from. This is
2815
 
        read locked, and generally is a local (and thus low latency) branch.
2816
 
    :ivar master_branch: If target is a bound branch, the master branch of
2817
 
        target, or target itself. Always write locked.
2818
 
    :ivar target_branch: The direct Branch where data is being sent (write
2819
 
        locked).
2820
 
    :ivar local_branch: If the target is a bound branch this will be the
2821
 
        target, otherwise it will be None.
2822
 
    """
2823
 
 
2824
 
    def __int__(self):
2825
 
        # DEPRECATED: push used to return the change in revno
2826
 
        return self.new_revno - self.old_revno
2827
 
 
2828
 
    def report(self, to_file):
2829
 
        """Write a human-readable description of the result."""
2830
 
        if self.old_revid == self.new_revid:
2831
 
            note('No new revisions to push.')
2832
 
        else:
2833
 
            note('Pushed up to revision %d.' % self.new_revno)
2834
 
        self._show_tag_conficts(to_file)
2835
 
 
2836
 
 
2837
 
class BranchCheckResult(object):
2838
 
    """Results of checking branch consistency.
2839
 
 
2840
 
    :see: Branch.check
2841
 
    """
2842
 
 
2843
 
    def __init__(self, branch):
2844
 
        self.branch = branch
2845
 
        self.errors = []
2846
 
 
2847
 
    def report_results(self, verbose):
2848
 
        """Report the check results via trace.note.
2849
 
 
2850
 
        :param verbose: Requests more detailed display of what was checked,
2851
 
            if any.
2852
 
        """
2853
 
        note('checked branch %s format %s', self.branch.base,
2854
 
            self.branch._format)
2855
 
        for error in self.errors:
2856
 
            note('found error:%s', error)
2857
 
 
2858
 
 
2859
 
class Converter5to6(object):
2860
 
    """Perform an in-place upgrade of format 5 to format 6"""
2861
 
 
2862
 
    def convert(self, branch):
2863
 
        # Data for 5 and 6 can peacefully coexist.
2864
 
        format = BzrBranchFormat6()
2865
 
        new_branch = format.open(branch.bzrdir, _found=True)
2866
 
 
2867
 
        # Copy source data into target
2868
 
        new_branch._write_last_revision_info(*branch.last_revision_info())
2869
 
        new_branch.set_parent(branch.get_parent())
2870
 
        new_branch.set_bound_location(branch.get_bound_location())
2871
 
        new_branch.set_push_location(branch.get_push_location())
2872
 
 
2873
 
        # New branch has no tags by default
2874
 
        new_branch.tags._set_tag_dict({})
2875
 
 
2876
 
        # Copying done; now update target format
2877
 
        new_branch._transport.put_bytes('format',
2878
 
            format.get_format_string(),
2879
 
            mode=new_branch.bzrdir._get_file_mode())
2880
 
 
2881
 
        # Clean up old files
2882
 
        new_branch._transport.delete('revision-history')
2883
 
        try:
2884
 
            branch.set_parent(None)
2885
 
        except errors.NoSuchFile:
2886
 
            pass
2887
 
        branch.set_bound_location(None)
2888
 
 
2889
 
 
2890
 
class Converter6to7(object):
2891
 
    """Perform an in-place upgrade of format 6 to format 7"""
2892
 
 
2893
 
    def convert(self, branch):
2894
 
        format = BzrBranchFormat7()
2895
 
        branch._set_config_location('stacked_on_location', '')
2896
 
        # update target format
2897
 
        branch._transport.put_bytes('format', format.get_format_string())
2898
 
 
2899
 
 
2900
 
class Converter7to8(object):
2901
 
    """Perform an in-place upgrade of format 6 to format 7"""
2902
 
 
2903
 
    def convert(self, branch):
2904
 
        format = BzrBranchFormat8()
2905
 
        branch._transport.put_bytes('references', '')
2906
 
        # update target format
2907
 
        branch._transport.put_bytes('format', format.get_format_string())
2908
 
 
2909
 
 
2910
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2911
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2912
 
    duration.
2913
 
 
2914
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
2915
 
 
2916
 
    If an exception is raised by callable, then that exception *will* be
2917
 
    propagated, even if the unlock attempt raises its own error.  Thus
2918
 
    _run_with_write_locked_target should be preferred to simply doing::
2919
 
 
2920
 
        target.lock_write()
2921
 
        try:
2922
 
            return callable(*args, **kwargs)
2923
 
        finally:
2924
 
            target.unlock()
2925
 
 
2926
 
    """
2927
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
2928
 
    # should share code?
2929
 
    target.lock_write()
2930
 
    try:
2931
 
        result = callable(*args, **kwargs)
2932
 
    except:
2933
 
        exc_info = sys.exc_info()
2934
 
        try:
2935
 
            target.unlock()
2936
 
        finally:
2937
 
            raise exc_info[0], exc_info[1], exc_info[2]
2938
 
    else:
2939
 
        target.unlock()
2940
 
        return result
2941
 
 
2942
 
 
2943
 
class InterBranch(InterObject):
2944
 
    """This class represents operations taking place between two branches.
2945
 
 
2946
 
    Its instances have methods like pull() and push() and contain
2947
 
    references to the source and target repositories these operations
2948
 
    can be carried out on.
2949
 
    """
2950
 
 
2951
 
    _optimisers = []
2952
 
    """The available optimised InterBranch types."""
2953
 
 
2954
 
    @staticmethod
2955
 
    def _get_branch_formats_to_test():
2956
 
        """Return a tuple with the Branch formats to use when testing."""
2957
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2958
 
 
2959
 
    def pull(self, overwrite=False, stop_revision=None,
2960
 
             possible_transports=None, local=False):
2961
 
        """Mirror source into target branch.
2962
 
 
2963
 
        The target branch is considered to be 'local', having low latency.
2964
 
 
2965
 
        :returns: PullResult instance
2966
 
        """
2967
 
        raise NotImplementedError(self.pull)
2968
 
 
2969
 
    def update_revisions(self, stop_revision=None, overwrite=False,
2970
 
                         graph=None):
2971
 
        """Pull in new perfect-fit revisions.
2972
 
 
2973
 
        :param stop_revision: Updated until the given revision
2974
 
        :param overwrite: Always set the branch pointer, rather than checking
2975
 
            to see if it is a proper descendant.
2976
 
        :param graph: A Graph object that can be used to query history
2977
 
            information. This can be None.
2978
 
        :return: None
2979
 
        """
2980
 
        raise NotImplementedError(self.update_revisions)
2981
 
 
2982
 
    def push(self, overwrite=False, stop_revision=None,
2983
 
             _override_hook_source_branch=None):
2984
 
        """Mirror the source branch into the target branch.
2985
 
 
2986
 
        The source branch is considered to be 'local', having low latency.
2987
 
        """
2988
 
        raise NotImplementedError(self.push)
2989
 
 
2990
 
 
2991
 
class GenericInterBranch(InterBranch):
2992
 
    """InterBranch implementation that uses public Branch functions.
2993
 
    """
2994
 
 
2995
 
    @staticmethod
2996
 
    def _get_branch_formats_to_test():
2997
 
        return BranchFormat._default_format, BranchFormat._default_format
2998
 
 
2999
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3000
 
        graph=None):
3001
 
        """See InterBranch.update_revisions()."""
3002
 
        self.source.lock_read()
3003
 
        try:
3004
 
            other_revno, other_last_revision = self.source.last_revision_info()
3005
 
            stop_revno = None # unknown
3006
 
            if stop_revision is None:
3007
 
                stop_revision = other_last_revision
3008
 
                if _mod_revision.is_null(stop_revision):
3009
 
                    # if there are no commits, we're done.
3010
 
                    return
3011
 
                stop_revno = other_revno
3012
 
 
3013
 
            # what's the current last revision, before we fetch [and change it
3014
 
            # possibly]
3015
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3016
 
            # we fetch here so that we don't process data twice in the common
3017
 
            # case of having something to pull, and so that the check for
3018
 
            # already merged can operate on the just fetched graph, which will
3019
 
            # be cached in memory.
3020
 
            self.target.fetch(self.source, stop_revision)
3021
 
            # Check to see if one is an ancestor of the other
3022
 
            if not overwrite:
3023
 
                if graph is None:
3024
 
                    graph = self.target.repository.get_graph()
3025
 
                if self.target._check_if_descendant_or_diverged(
3026
 
                        stop_revision, last_rev, graph, self.source):
3027
 
                    # stop_revision is a descendant of last_rev, but we aren't
3028
 
                    # overwriting, so we're done.
3029
 
                    return
3030
 
            if stop_revno is None:
3031
 
                if graph is None:
3032
 
                    graph = self.target.repository.get_graph()
3033
 
                this_revno, this_last_revision = \
3034
 
                        self.target.last_revision_info()
3035
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3036
 
                                [(other_last_revision, other_revno),
3037
 
                                 (this_last_revision, this_revno)])
3038
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3039
 
        finally:
3040
 
            self.source.unlock()
3041
 
 
3042
 
    def pull(self, overwrite=False, stop_revision=None,
3043
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3044
 
             _override_hook_target=None, local=False):
3045
 
        """See Branch.pull.
3046
 
 
3047
 
        :param _hook_master: Private parameter - set the branch to
3048
 
            be supplied as the master to pull hooks.
3049
 
        :param run_hooks: Private parameter - if false, this branch
3050
 
            is being called because it's the master of the primary branch,
3051
 
            so it should not run its hooks.
3052
 
        :param _override_hook_target: Private parameter - set the branch to be
3053
 
            supplied as the target_branch to pull hooks.
3054
 
        :param local: Only update the local branch, and not the bound branch.
3055
 
        """
3056
 
        # This type of branch can't be bound.
3057
 
        if local:
3058
 
            raise errors.LocalRequiresBoundBranch()
3059
 
        result = PullResult()
3060
 
        result.source_branch = self.source
3061
 
        if _override_hook_target is None:
3062
 
            result.target_branch = self.target
3063
 
        else:
3064
 
            result.target_branch = _override_hook_target
3065
 
        self.source.lock_read()
3066
 
        try:
3067
 
            # We assume that during 'pull' the target repository is closer than
3068
 
            # the source one.
3069
 
            self.source.update_references(self.target)
3070
 
            graph = self.target.repository.get_graph(self.source.repository)
3071
 
            # TODO: Branch formats should have a flag that indicates 
3072
 
            # that revno's are expensive, and pull() should honor that flag.
3073
 
            # -- JRV20090506
3074
 
            result.old_revno, result.old_revid = \
3075
 
                self.target.last_revision_info()
3076
 
            self.target.update_revisions(self.source, stop_revision,
3077
 
                overwrite=overwrite, graph=graph)
3078
 
            # TODO: The old revid should be specified when merging tags, 
3079
 
            # so a tags implementation that versions tags can only 
3080
 
            # pull in the most recent changes. -- JRV20090506
3081
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3082
 
                overwrite)
3083
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3084
 
            if _hook_master:
3085
 
                result.master_branch = _hook_master
3086
 
                result.local_branch = result.target_branch
3087
 
            else:
3088
 
                result.master_branch = result.target_branch
3089
 
                result.local_branch = None
3090
 
            if run_hooks:
3091
 
                for hook in Branch.hooks['post_pull']:
3092
 
                    hook(result)
3093
 
        finally:
3094
 
            self.source.unlock()
3095
 
        return result
3096
 
 
3097
 
    def push(self, overwrite=False, stop_revision=None,
3098
 
             _override_hook_source_branch=None):
3099
 
        """See InterBranch.push.
3100
 
 
3101
 
        This is the basic concrete implementation of push()
3102
 
 
3103
 
        :param _override_hook_source_branch: If specified, run
3104
 
        the hooks passing this Branch as the source, rather than self.
3105
 
        This is for use of RemoteBranch, where push is delegated to the
3106
 
        underlying vfs-based Branch.
3107
 
        """
3108
 
        # TODO: Public option to disable running hooks - should be trivial but
3109
 
        # needs tests.
3110
 
        self.source.lock_read()
3111
 
        try:
3112
 
            return _run_with_write_locked_target(
3113
 
                self.target, self._push_with_bound_branches, overwrite,
3114
 
                stop_revision,
3115
 
                _override_hook_source_branch=_override_hook_source_branch)
3116
 
        finally:
3117
 
            self.source.unlock()
3118
 
 
3119
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3120
 
            _override_hook_source_branch=None):
3121
 
        """Push from source into target, and into target's master if any.
3122
 
        """
3123
 
        def _run_hooks():
3124
 
            if _override_hook_source_branch:
3125
 
                result.source_branch = _override_hook_source_branch
3126
 
            for hook in Branch.hooks['post_push']:
3127
 
                hook(result)
3128
 
 
3129
 
        bound_location = self.target.get_bound_location()
3130
 
        if bound_location and self.target.base != bound_location:
3131
 
            # there is a master branch.
3132
 
            #
3133
 
            # XXX: Why the second check?  Is it even supported for a branch to
3134
 
            # be bound to itself? -- mbp 20070507
3135
 
            master_branch = self.target.get_master_branch()
3136
 
            master_branch.lock_write()
3137
 
            try:
3138
 
                # push into the master from the source branch.
3139
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3140
 
                # and push into the target branch from the source. Note that we
3141
 
                # push from the source branch again, because its considered the
3142
 
                # highest bandwidth repository.
3143
 
                result = self.source._basic_push(self.target, overwrite,
3144
 
                    stop_revision)
3145
 
                result.master_branch = master_branch
3146
 
                result.local_branch = self.target
3147
 
                _run_hooks()
3148
 
                return result
3149
 
            finally:
3150
 
                master_branch.unlock()
3151
 
        else:
3152
 
            # no master branch
3153
 
            result = self.source._basic_push(self.target, overwrite,
3154
 
                stop_revision)
3155
 
            # TODO: Why set master_branch and local_branch if there's no
3156
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3157
 
            # 20070504
3158
 
            result.master_branch = self.target
3159
 
            result.local_branch = None
3160
 
            _run_hooks()
3161
 
            return result
3162
 
 
3163
 
    @classmethod
3164
 
    def is_compatible(self, source, target):
3165
 
        # GenericBranch uses the public API, so always compatible
3166
 
        return True
3167
 
 
3168
 
 
3169
 
class InterToBranch5(GenericInterBranch):
3170
 
 
3171
 
    @staticmethod
3172
 
    def _get_branch_formats_to_test():
3173
 
        return BranchFormat._default_format, BzrBranchFormat5()
3174
 
 
3175
 
    def pull(self, overwrite=False, stop_revision=None,
3176
 
             possible_transports=None, run_hooks=True,
3177
 
             _override_hook_target=None, local=False):
3178
 
        """Pull from source into self, updating my master if any.
3179
 
 
3180
 
        :param run_hooks: Private parameter - if false, this branch
3181
 
            is being called because it's the master of the primary branch,
3182
 
            so it should not run its hooks.
3183
 
        """
3184
 
        bound_location = self.target.get_bound_location()
3185
 
        if local and not bound_location:
3186
 
            raise errors.LocalRequiresBoundBranch()
3187
 
        master_branch = None
3188
 
        if not local and bound_location and self.source.base != bound_location:
3189
 
            # not pulling from master, so we need to update master.
3190
 
            master_branch = self.target.get_master_branch(possible_transports)
3191
 
            master_branch.lock_write()
3192
 
        try:
3193
 
            if master_branch:
3194
 
                # pull from source into master.
3195
 
                master_branch.pull(self.source, overwrite, stop_revision,
3196
 
                    run_hooks=False)
3197
 
            return super(InterToBranch5, self).pull(overwrite,
3198
 
                stop_revision, _hook_master=master_branch,
3199
 
                run_hooks=run_hooks,
3200
 
                _override_hook_target=_override_hook_target)
3201
 
        finally:
3202
 
            if master_branch:
3203
 
                master_branch.unlock()
3204
 
 
3205
 
 
3206
 
InterBranch.register_optimiser(GenericInterBranch)
3207
 
InterBranch.register_optimiser(InterToBranch5)
 
1338
# predicates
 
1339
 
 
1340
 
 
1341
@deprecated_function(zero_eight)
 
1342
def ScratchBranch(*args, **kwargs):
 
1343
    """See bzrlib.bzrdir.ScratchDir."""
 
1344
    d = ScratchDir(*args, **kwargs)
 
1345
    return d.open_branch()
 
1346
 
 
1347
 
 
1348
@deprecated_function(zero_eight)
 
1349
def is_control_file(*args, **kwargs):
 
1350
    """See bzrlib.workingtree.is_control_file."""
 
1351
    return bzrlib.workingtree.is_control_file(*args, **kwargs)