/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robey Pointer
  • Date: 2006-09-08 18:46:29 UTC
  • mto: This revision was merged to the branch mainline in revision 1996.
  • Revision ID: robey@lag.net-20060908184629-e3fc4c61ca21508c
pychecker is on crack; go back to using 'is None'.

Show diffs side-by-side

added added

removed removed

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