~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

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