~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2007-07-04 02:43:26 UTC
  • mto: This revision was merged to the branch mainline in revision 2581.
  • Revision ID: robertc@robertcollins.net-20070704024326-czaqy9flaooda2jj
Fix missed tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
 
 
18
 
import sys
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
from cStringIO import StringIO
19
19
 
20
20
from bzrlib.lazy_import import lazy_import
21
21
lazy_import(globals(), """
22
 
from itertools import chain
 
22
from warnings import warn
 
23
 
 
24
import bzrlib
23
25
from bzrlib import (
24
26
        bzrdir,
25
27
        cache_utf8,
26
28
        config as _mod_config,
27
 
        debug,
28
29
        errors,
29
30
        lockdir,
30
31
        lockable_files,
31
 
        repository,
 
32
        osutils,
32
33
        revision as _mod_revision,
33
 
        symbol_versioning,
34
34
        transport,
 
35
        tree,
35
36
        tsort,
36
37
        ui,
37
38
        urlutils,
38
39
        )
39
 
from bzrlib.config import BranchConfig, TransportConfig
40
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
40
from bzrlib.config import BranchConfig, TreeConfig
 
41
from bzrlib.lockable_files import LockableFiles, TransportLock
41
42
from bzrlib.tag import (
42
43
    BasicTags,
43
44
    DisabledTags,
45
46
""")
46
47
 
47
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
48
 
from bzrlib.hooks import HookPoint, Hooks
49
 
from bzrlib.inter import InterObject
50
 
from bzrlib import registry
51
 
from bzrlib.symbol_versioning import (
52
 
    deprecated_in,
53
 
    deprecated_method,
54
 
    )
55
 
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
 
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
 
50
                           HistoryMissing, InvalidRevisionId,
 
51
                           InvalidRevisionNumber, LockError, NoSuchFile,
 
52
                           NoSuchRevision, NoWorkingTree, NotVersionedError,
 
53
                           NotBranchError, UninitializableFormat,
 
54
                           UnlistableStore, UnlistableBranch,
 
55
                           )
 
56
from bzrlib.hooks import Hooks
 
57
from bzrlib.symbol_versioning import (deprecated_function,
 
58
                                      deprecated_method,
 
59
                                      DEPRECATED_PARAMETER,
 
60
                                      deprecated_passed,
 
61
                                      zero_eight, zero_nine, zero_sixteen,
 
62
                                      )
 
63
from bzrlib.trace import mutter, note
56
64
 
57
65
 
58
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
84
92
    # - RBC 20060112
85
93
    base = None
86
94
 
 
95
    # override this to set the strategy for storing tags
 
96
    def _make_tags(self):
 
97
        return DisabledTags(self)
 
98
 
87
99
    def __init__(self, *ignored, **ignored_too):
88
 
        self.tags = self._format.make_tags(self)
 
100
        self.tags = self._make_tags()
89
101
        self._revision_history_cache = None
90
102
        self._revision_id_to_revno_cache = None
91
 
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._last_revision_info_cache = None
93
 
        self._merge_sorted_revisions_cache = None
94
 
        self._open_hook()
95
 
        hooks = Branch.hooks['open']
96
 
        for hook in hooks:
97
 
            hook(self)
98
 
 
99
 
    def _open_hook(self):
100
 
        """Called by init to allow simpler extension of the base class."""
101
 
 
102
 
    def _activate_fallback_location(self, url):
103
 
        """Activate the branch/repository from url as a fallback repository."""
104
 
        self.repository.add_fallback_repository(
105
 
            self._get_fallback_repository(url))
106
103
 
107
104
    def break_lock(self):
108
105
        """Break a lock if one is present from another instance.
118
115
        if master is not None:
119
116
            master.break_lock()
120
117
 
121
 
    def _check_stackable_repo(self):
122
 
        if not self.repository._format.supports_external_lookups:
123
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
124
 
                self.repository.base)
125
 
 
126
 
    @staticmethod
127
 
    def open(base, _unsupported=False, possible_transports=None):
 
118
    @staticmethod
 
119
    @deprecated_method(zero_eight)
 
120
    def open_downlevel(base):
 
121
        """Open a branch which may be of an old format."""
 
122
        return Branch.open(base, _unsupported=True)
 
123
        
 
124
    @staticmethod
 
125
    def open(base, _unsupported=False):
128
126
        """Open the branch rooted at base.
129
127
 
130
128
        For instance, if the branch is at URL/.bzr/branch,
131
129
        Branch.open(URL) -> a Branch instance.
132
130
        """
133
 
        control = bzrdir.BzrDir.open(base, _unsupported,
134
 
                                     possible_transports=possible_transports)
135
 
        return control.open_branch(_unsupported)
136
 
 
137
 
    @staticmethod
138
 
    def open_from_transport(transport, _unsupported=False):
139
 
        """Open the branch rooted at transport"""
140
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
141
 
        return control.open_branch(_unsupported)
142
 
 
143
 
    @staticmethod
144
 
    def open_containing(url, possible_transports=None):
 
131
        control = bzrdir.BzrDir.open(base, _unsupported)
 
132
        return control.open_branch(_unsupported)
 
133
 
 
134
    @staticmethod
 
135
    def open_containing(url):
145
136
        """Open an existing branch which contains url.
146
 
 
 
137
        
147
138
        This probes for a branch at url, and searches upwards from there.
148
139
 
149
140
        Basically we keep looking up until we find the control directory or
150
141
        run into the root.  If there isn't one, raises NotBranchError.
151
 
        If there is one and it is either an unrecognised format or an unsupported
 
142
        If there is one and it is either an unrecognised format or an unsupported 
152
143
        format, UnknownFormatError or UnsupportedFormatError are raised.
153
144
        If there is one, it is returned, along with the unused portion of url.
154
145
        """
155
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
156
 
                                                         possible_transports)
 
146
        control, relpath = bzrdir.BzrDir.open_containing(url)
157
147
        return control.open_branch(), relpath
158
148
 
159
 
    def _push_should_merge_tags(self):
160
 
        """Should _basic_push merge this branch's tags into the target?
161
 
 
162
 
        The default implementation returns False if this branch has no tags,
163
 
        and True the rest of the time.  Subclasses may override this.
164
 
        """
165
 
        return self.supports_tags() and self.tags.get_tag_dict()
 
149
    @staticmethod
 
150
    @deprecated_function(zero_eight)
 
151
    def initialize(base):
 
152
        """Create a new working tree and branch, rooted at 'base' (url)
 
153
 
 
154
        NOTE: This will soon be deprecated in favour of creation
 
155
        through a BzrDir.
 
156
        """
 
157
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
 
158
 
 
159
    @deprecated_function(zero_eight)
 
160
    def setup_caching(self, cache_root):
 
161
        """Subclasses that care about caching should override this, and set
 
162
        up cached stores located under cache_root.
 
163
        
 
164
        NOTE: This is unused.
 
165
        """
 
166
        pass
166
167
 
167
168
    def get_config(self):
168
169
        return BranchConfig(self)
169
170
 
170
 
    def _get_config(self):
171
 
        """Get the concrete config for just the config in this branch.
172
 
 
173
 
        This is not intended for client use; see Branch.get_config for the
174
 
        public API.
175
 
 
176
 
        Added in 1.14.
177
 
 
178
 
        :return: An object supporting get_option and set_option.
179
 
        """
180
 
        raise NotImplementedError(self._get_config)
181
 
 
182
 
    def _get_fallback_repository(self, url):
183
 
        """Get the repository we fallback to at url."""
184
 
        url = urlutils.join(self.base, url)
185
 
        a_bzrdir = bzrdir.BzrDir.open(url,
186
 
            possible_transports=[self.bzrdir.root_transport])
187
 
        return a_bzrdir.open_branch().repository
188
 
 
189
 
    def _get_tags_bytes(self):
190
 
        """Get the bytes of a serialised tags dict.
191
 
 
192
 
        Note that not all branches support tags, nor do all use the same tags
193
 
        logic: this method is specific to BasicTags. Other tag implementations
194
 
        may use the same method name and behave differently, safely, because
195
 
        of the double-dispatch via
196
 
        format.make_tags->tags_instance->get_tags_dict.
197
 
 
198
 
        :return: The bytes of the tags file.
199
 
        :seealso: Branch._set_tags_bytes.
200
 
        """
201
 
        return self._transport.get_bytes('tags')
202
 
 
203
 
    def _get_nick(self, local=False, possible_transports=None):
204
 
        config = self.get_config()
205
 
        # explicit overrides master, but don't look for master if local is True
206
 
        if not local and not config.has_explicit_nickname():
207
 
            try:
208
 
                master = self.get_master_branch(possible_transports)
209
 
                if master is not None:
210
 
                    # return the master branch value
211
 
                    return master.nick
212
 
            except errors.BzrError, e:
213
 
                # Silently fall back to local implicit nick if the master is
214
 
                # unavailable
215
 
                mutter("Could not connect to bound branch, "
216
 
                    "falling back to local nick.\n " + str(e))
217
 
        return config.get_nickname()
 
171
    def _get_nick(self):
 
172
        return self.get_config().get_nickname()
218
173
 
219
174
    def _set_nick(self, nick):
220
 
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
 
175
        self.get_config().set_user_option('nickname', nick)
221
176
 
222
177
    nick = property(_get_nick, _set_nick)
223
178
 
224
179
    def is_locked(self):
225
180
        raise NotImplementedError(self.is_locked)
226
181
 
227
 
    def _lefthand_history(self, revision_id, last_rev=None,
228
 
                          other_branch=None):
229
 
        if 'evil' in debug.debug_flags:
230
 
            mutter_callsite(4, "_lefthand_history scales with history.")
231
 
        # stop_revision must be a descendant of last_revision
232
 
        graph = self.repository.get_graph()
233
 
        if last_rev is not None:
234
 
            if not graph.is_ancestor(last_rev, revision_id):
235
 
                # our previous tip is not merged into stop_revision
236
 
                raise errors.DivergedBranches(self, other_branch)
237
 
        # make a new revision history from the graph
238
 
        parents_map = graph.get_parent_map([revision_id])
239
 
        if revision_id not in parents_map:
240
 
            raise errors.NoSuchRevision(self, revision_id)
241
 
        current_rev_id = revision_id
242
 
        new_history = []
243
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
244
 
        # Do not include ghosts or graph origin in revision_history
245
 
        while (current_rev_id in parents_map and
246
 
               len(parents_map[current_rev_id]) > 0):
247
 
            check_not_reserved_id(current_rev_id)
248
 
            new_history.append(current_rev_id)
249
 
            current_rev_id = parents_map[current_rev_id][0]
250
 
            parents_map = graph.get_parent_map([current_rev_id])
251
 
        new_history.reverse()
252
 
        return new_history
253
 
 
254
182
    def lock_write(self):
255
183
        raise NotImplementedError(self.lock_write)
256
184
 
268
196
        raise NotImplementedError(self.get_physical_lock_status)
269
197
 
270
198
    @needs_read_lock
271
 
    def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
272
 
        """Return the revision_id for a dotted revno.
273
 
 
274
 
        :param revno: a tuple like (1,) or (1,1,2)
275
 
        :param _cache_reverse: a private parameter enabling storage
276
 
           of the reverse mapping in a top level cache. (This should
277
 
           only be done in selective circumstances as we want to
278
 
           avoid having the mapping cached multiple times.)
279
 
        :return: the revision_id
280
 
        :raises errors.NoSuchRevision: if the revno doesn't exist
281
 
        """
282
 
        rev_id = self._do_dotted_revno_to_revision_id(revno)
283
 
        if _cache_reverse:
284
 
            self._partial_revision_id_to_revno_cache[rev_id] = revno
285
 
        return rev_id
286
 
 
287
 
    def _do_dotted_revno_to_revision_id(self, revno):
288
 
        """Worker function for dotted_revno_to_revision_id.
289
 
 
290
 
        Subclasses should override this if they wish to
291
 
        provide a more efficient implementation.
292
 
        """
293
 
        if len(revno) == 1:
294
 
            return self.get_rev_id(revno[0])
295
 
        revision_id_to_revno = self.get_revision_id_to_revno_map()
296
 
        revision_ids = [revision_id for revision_id, this_revno
297
 
                        in revision_id_to_revno.iteritems()
298
 
                        if revno == this_revno]
299
 
        if len(revision_ids) == 1:
300
 
            return revision_ids[0]
301
 
        else:
302
 
            revno_str = '.'.join(map(str, revno))
303
 
            raise errors.NoSuchRevision(self, revno_str)
304
 
 
305
 
    @needs_read_lock
306
 
    def revision_id_to_dotted_revno(self, revision_id):
307
 
        """Given a revision id, return its dotted revno.
308
 
 
309
 
        :return: a tuple like (1,) or (400,1,3).
310
 
        """
311
 
        return self._do_revision_id_to_dotted_revno(revision_id)
312
 
 
313
 
    def _do_revision_id_to_dotted_revno(self, revision_id):
314
 
        """Worker function for revision_id_to_revno."""
315
 
        # Try the caches if they are loaded
316
 
        result = self._partial_revision_id_to_revno_cache.get(revision_id)
317
 
        if result is not None:
318
 
            return result
319
 
        if self._revision_id_to_revno_cache:
320
 
            result = self._revision_id_to_revno_cache.get(revision_id)
321
 
            if result is None:
322
 
                raise errors.NoSuchRevision(self, revision_id)
323
 
        # Try the mainline as it's optimised
324
 
        try:
325
 
            revno = self.revision_id_to_revno(revision_id)
326
 
            return (revno,)
327
 
        except errors.NoSuchRevision:
328
 
            # We need to load and use the full revno map after all
329
 
            result = self.get_revision_id_to_revno_map().get(revision_id)
330
 
            if result is None:
331
 
                raise errors.NoSuchRevision(self, revision_id)
332
 
        return result
333
 
 
334
 
    @needs_read_lock
335
199
    def get_revision_id_to_revno_map(self):
336
200
        """Return the revision_id => dotted revno map.
337
201
 
361
225
 
362
226
        :return: A dictionary mapping revision_id => dotted revno.
363
227
        """
 
228
        last_revision = self.last_revision()
 
229
        revision_graph = self.repository.get_revision_graph(last_revision)
 
230
        merge_sorted_revisions = tsort.merge_sort(
 
231
            revision_graph,
 
232
            last_revision,
 
233
            None,
 
234
            generate_revno=True)
364
235
        revision_id_to_revno = dict((rev_id, revno)
365
 
            for rev_id, depth, revno, end_of_merge
366
 
             in self.iter_merge_sorted_revisions())
 
236
                                    for seq_num, rev_id, depth, revno, end_of_merge
 
237
                                     in merge_sorted_revisions)
367
238
        return revision_id_to_revno
368
239
 
369
 
    @needs_read_lock
370
 
    def iter_merge_sorted_revisions(self, start_revision_id=None,
371
 
            stop_revision_id=None, stop_rule='exclude', direction='reverse'):
372
 
        """Walk the revisions for a branch in merge sorted order.
373
 
 
374
 
        Merge sorted order is the output from a merge-aware,
375
 
        topological sort, i.e. all parents come before their
376
 
        children going forward; the opposite for reverse.
377
 
 
378
 
        :param start_revision_id: the revision_id to begin walking from.
379
 
            If None, the branch tip is used.
380
 
        :param stop_revision_id: the revision_id to terminate the walk
381
 
            after. If None, the rest of history is included.
382
 
        :param stop_rule: if stop_revision_id is not None, the precise rule
383
 
            to use for termination:
384
 
            * 'exclude' - leave the stop revision out of the result (default)
385
 
            * 'include' - the stop revision is the last item in the result
386
 
            * 'with-merges' - include the stop revision and all of its
387
 
              merged revisions in the result
388
 
        :param direction: either 'reverse' or 'forward':
389
 
            * reverse means return the start_revision_id first, i.e.
390
 
              start at the most recent revision and go backwards in history
391
 
            * forward returns tuples in the opposite order to reverse.
392
 
              Note in particular that forward does *not* do any intelligent
393
 
              ordering w.r.t. depth as some clients of this API may like.
394
 
              (If required, that ought to be done at higher layers.)
395
 
 
396
 
        :return: an iterator over (revision_id, depth, revno, end_of_merge)
397
 
            tuples where:
398
 
 
399
 
            * revision_id: the unique id of the revision
400
 
            * depth: How many levels of merging deep this node has been
401
 
              found.
402
 
            * revno_sequence: This field provides a sequence of
403
 
              revision numbers for all revisions. The format is:
404
 
              (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
405
 
              branch that the revno is on. From left to right the REVNO numbers
406
 
              are the sequence numbers within that branch of the revision.
407
 
            * end_of_merge: When True the next node (earlier in history) is
408
 
              part of a different merge.
409
 
        """
410
 
        # Note: depth and revno values are in the context of the branch so
411
 
        # we need the full graph to get stable numbers, regardless of the
412
 
        # start_revision_id.
413
 
        if self._merge_sorted_revisions_cache is None:
414
 
            last_revision = self.last_revision()
415
 
            graph = self.repository.get_graph()
416
 
            parent_map = dict(((key, value) for key, value in
417
 
                     graph.iter_ancestry([last_revision]) if value is not None))
418
 
            revision_graph = repository._strip_NULL_ghosts(parent_map)
419
 
            revs = tsort.merge_sort(revision_graph, last_revision, None,
420
 
                generate_revno=True)
421
 
            # Drop the sequence # before caching
422
 
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
423
 
 
424
 
        filtered = self._filter_merge_sorted_revisions(
425
 
            self._merge_sorted_revisions_cache, start_revision_id,
426
 
            stop_revision_id, stop_rule)
427
 
        if direction == 'reverse':
428
 
            return filtered
429
 
        if direction == 'forward':
430
 
            return reversed(list(filtered))
431
 
        else:
432
 
            raise ValueError('invalid direction %r' % direction)
433
 
 
434
 
    def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
435
 
        start_revision_id, stop_revision_id, stop_rule):
436
 
        """Iterate over an inclusive range of sorted revisions."""
437
 
        rev_iter = iter(merge_sorted_revisions)
438
 
        if start_revision_id is not None:
439
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
440
 
                if rev_id != start_revision_id:
441
 
                    continue
442
 
                else:
443
 
                    # The decision to include the start or not
444
 
                    # depends on the stop_rule if a stop is provided
445
 
                    rev_iter = chain(
446
 
                        iter([(rev_id, depth, revno, end_of_merge)]),
447
 
                        rev_iter)
448
 
                    break
449
 
        if stop_revision_id is None:
450
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
451
 
                yield rev_id, depth, revno, end_of_merge
452
 
        elif stop_rule == 'exclude':
453
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
454
 
                if rev_id == stop_revision_id:
455
 
                    return
456
 
                yield rev_id, depth, revno, end_of_merge
457
 
        elif stop_rule == 'include':
458
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
459
 
                yield rev_id, depth, revno, end_of_merge
460
 
                if rev_id == stop_revision_id:
461
 
                    return
462
 
        elif stop_rule == 'with-merges':
463
 
            stop_rev = self.repository.get_revision(stop_revision_id)
464
 
            if stop_rev.parent_ids:
465
 
                left_parent = stop_rev.parent_ids[0]
466
 
            else:
467
 
                left_parent = _mod_revision.NULL_REVISION
468
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
469
 
                if rev_id == left_parent:
470
 
                    return
471
 
                yield rev_id, depth, revno, end_of_merge
472
 
        else:
473
 
            raise ValueError('invalid stop_rule %r' % stop_rule)
474
 
 
475
240
    def leave_lock_in_place(self):
476
241
        """Tell this branch object not to release the physical lock when this
477
242
        object is unlocked.
478
 
 
 
243
        
479
244
        If lock_write doesn't return a token, then this method is not supported.
480
245
        """
481
246
        self.control_files.leave_in_place()
488
253
        """
489
254
        self.control_files.dont_leave_in_place()
490
255
 
 
256
    def abspath(self, name):
 
257
        """Return absolute filename for something in the branch
 
258
        
 
259
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
260
        method and not a tree method.
 
261
        """
 
262
        raise NotImplementedError(self.abspath)
 
263
 
491
264
    def bind(self, other):
492
265
        """Bind the local branch the other branch.
493
266
 
504
277
        :param last_revision: What revision to stop at (None for at the end
505
278
                              of the branch.
506
279
        :param pb: An optional progress bar to use.
507
 
        :return: None
 
280
 
 
281
        Returns the copied revision count and the failed revisions in a tuple:
 
282
        (copied, failures).
508
283
        """
509
284
        if self.base == from_branch.base:
510
285
            return (0, [])
511
 
        if pb is not None:
512
 
            symbol_versioning.warn(
513
 
                symbol_versioning.deprecated_in((1, 14, 0))
514
 
                % "pb parameter to fetch()")
 
286
        if pb is None:
 
287
            nested_pb = ui.ui_factory.nested_progress_bar()
 
288
            pb = nested_pb
 
289
        else:
 
290
            nested_pb = None
 
291
 
515
292
        from_branch.lock_read()
516
293
        try:
517
294
            if last_revision is None:
 
295
                pb.update('get source history')
518
296
                last_revision = from_branch.last_revision()
519
 
                last_revision = _mod_revision.ensure_null(last_revision)
 
297
                if last_revision is None:
 
298
                    last_revision = _mod_revision.NULL_REVISION
520
299
            return self.repository.fetch(from_branch.repository,
521
300
                                         revision_id=last_revision,
522
 
                                         pb=pb)
 
301
                                         pb=nested_pb)
523
302
        finally:
 
303
            if nested_pb is not None:
 
304
                nested_pb.finished()
524
305
            from_branch.unlock()
525
306
 
526
307
    def get_bound_location(self):
530
311
        branch.
531
312
        """
532
313
        return None
533
 
 
 
314
    
534
315
    def get_old_bound_location(self):
535
316
        """Return the URL of the branch we used to be bound to
536
317
        """
537
318
        raise errors.UpgradeRequired(self.base)
538
319
 
539
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
540
 
                           timezone=None, committer=None, revprops=None,
 
320
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
321
                           timezone=None, committer=None, revprops=None, 
541
322
                           revision_id=None):
542
323
        """Obtain a CommitBuilder for this branch.
543
 
 
 
324
        
544
325
        :param parents: Revision ids of the parents of the new revision.
545
326
        :param config: Optional configuration to use.
546
327
        :param timestamp: Optional timestamp recorded for commit.
552
333
 
553
334
        if config is None:
554
335
            config = self.get_config()
555
 
 
 
336
        
556
337
        return self.repository.get_commit_builder(self, parents, config,
557
338
            timestamp, timezone, committer, revprops, revision_id)
558
339
 
559
 
    def get_master_branch(self, possible_transports=None):
 
340
    def get_master_branch(self):
560
341
        """Return the branch we are bound to.
561
 
 
 
342
        
562
343
        :return: Either a Branch, or None
563
344
        """
564
345
        return None
569
350
        The delta is relative to its mainline predecessor, or the
570
351
        empty tree for revision 1.
571
352
        """
 
353
        assert isinstance(revno, int)
572
354
        rh = self.revision_history()
573
355
        if not (1 <= revno <= len(rh)):
574
 
            raise errors.InvalidRevisionNumber(revno)
 
356
            raise InvalidRevisionNumber(revno)
575
357
        return self.repository.get_revision_delta(rh[revno-1])
576
358
 
577
 
    def get_stacked_on_url(self):
578
 
        """Get the URL this branch is stacked against.
 
359
    @deprecated_method(zero_sixteen)
 
360
    def get_root_id(self):
 
361
        """Return the id of this branches root
579
362
 
580
 
        :raises NotStacked: If the branch is not stacked.
581
 
        :raises UnstackableBranchFormat: If the branch does not support
582
 
            stacking.
 
363
        Deprecated: branches don't have root ids-- trees do.
 
364
        Use basis_tree().get_root_id() instead.
583
365
        """
584
 
        raise NotImplementedError(self.get_stacked_on_url)
 
366
        raise NotImplementedError(self.get_root_id)
585
367
 
586
368
    def print_file(self, file, revision_id):
587
369
        """Print `file` to stdout."""
588
370
        raise NotImplementedError(self.print_file)
589
371
 
 
372
    def append_revision(self, *revision_ids):
 
373
        raise NotImplementedError(self.append_revision)
 
374
 
590
375
    def set_revision_history(self, rev_history):
591
376
        raise NotImplementedError(self.set_revision_history)
592
377
 
593
 
    def set_stacked_on_url(self, url):
594
 
        """Set the URL this branch is stacked against.
595
 
 
596
 
        :raises UnstackableBranchFormat: If the branch does not support
597
 
            stacking.
598
 
        :raises UnstackableRepositoryFormat: If the repository does not support
599
 
            stacking.
600
 
        """
601
 
        if not self._format.supports_stacking():
602
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
603
 
        self._check_stackable_repo()
604
 
        if not url:
605
 
            try:
606
 
                old_url = self.get_stacked_on_url()
607
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
608
 
                errors.UnstackableRepositoryFormat):
609
 
                return
610
 
            url = ''
611
 
            # repositories don't offer an interface to remove fallback
612
 
            # repositories today; take the conceptually simpler option and just
613
 
            # reopen it.
614
 
            self.repository = self.bzrdir.find_repository()
615
 
            # for every revision reference the branch has, ensure it is pulled
616
 
            # in.
617
 
            source_repository = self._get_fallback_repository(old_url)
618
 
            for revision_id in chain([self.last_revision()],
619
 
                self.tags.get_reverse_tag_dict()):
620
 
                self.repository.fetch(source_repository, revision_id,
621
 
                    find_ghosts=True)
622
 
        else:
623
 
            self._activate_fallback_location(url)
624
 
        # write this out after the repository is stacked to avoid setting a
625
 
        # stacked config that doesn't work.
626
 
        self._set_config_location('stacked_on_location', url)
627
 
 
628
 
 
629
 
    def _set_tags_bytes(self, bytes):
630
 
        """Mirror method for _get_tags_bytes.
631
 
 
632
 
        :seealso: Branch._get_tags_bytes.
633
 
        """
634
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
635
 
            'tags', bytes)
636
 
 
637
378
    def _cache_revision_history(self, rev_history):
638
379
        """Set the cached revision history to rev_history.
639
380
 
664
405
        """
665
406
        self._revision_history_cache = None
666
407
        self._revision_id_to_revno_cache = None
667
 
        self._last_revision_info_cache = None
668
 
        self._merge_sorted_revisions_cache = None
669
408
 
670
409
    def _gen_revision_history(self):
671
410
        """Return sequence of revision hashes on to this branch.
672
 
 
 
411
        
673
412
        Unlike revision_history, this method always regenerates or rereads the
674
413
        revision history, i.e. it does not cache the result, so repeated calls
675
414
        may be expensive.
676
415
 
677
416
        Concrete subclasses should override this instead of revision_history so
678
417
        that subclasses do not need to deal with caching logic.
679
 
 
 
418
        
680
419
        This API is semi-public; it only for use by subclasses, all other code
681
420
        should consider it to be private.
682
421
        """
684
423
 
685
424
    @needs_read_lock
686
425
    def revision_history(self):
687
 
        """Return sequence of revision ids on this branch.
688
 
 
 
426
        """Return sequence of revision hashes on to this branch.
 
427
        
689
428
        This method will cache the revision history for as long as it is safe to
690
429
        do so.
691
430
        """
692
 
        if 'evil' in debug.debug_flags:
693
 
            mutter_callsite(3, "revision_history scales with history.")
694
431
        if self._revision_history_cache is not None:
695
432
            history = self._revision_history_cache
696
433
        else:
704
441
        That is equivalent to the number of revisions committed to
705
442
        this branch.
706
443
        """
707
 
        return self.last_revision_info()[0]
 
444
        return len(self.revision_history())
708
445
 
709
446
    def unbind(self):
710
447
        """Older format branches cannot bind or unbind."""
715
452
        raise errors.UpgradeRequired(self.base)
716
453
 
717
454
    def last_revision(self):
718
 
        """Return last revision id, or NULL_REVISION."""
719
 
        return self.last_revision_info()[1]
 
455
        """Return last revision id, or None"""
 
456
        ph = self.revision_history()
 
457
        if ph:
 
458
            return ph[-1]
 
459
        else:
 
460
            return None
720
461
 
721
 
    @needs_read_lock
722
462
    def last_revision_info(self):
723
463
        """Return information about the last revision.
724
464
 
725
 
        :return: A tuple (revno, revision_id).
 
465
        :return: A tuple (revno, last_revision_id).
726
466
        """
727
 
        if self._last_revision_info_cache is None:
728
 
            self._last_revision_info_cache = self._last_revision_info()
729
 
        return self._last_revision_info_cache
730
 
 
731
 
    def _last_revision_info(self):
732
467
        rh = self.revision_history()
733
468
        revno = len(rh)
734
469
        if revno:
736
471
        else:
737
472
            return (0, _mod_revision.NULL_REVISION)
738
473
 
739
 
    @deprecated_method(deprecated_in((1, 6, 0)))
740
474
    def missing_revisions(self, other, stop_revision=None):
741
475
        """Return a list of new revisions that would perfectly fit.
742
 
 
 
476
        
743
477
        If self and other have not diverged, return a list of the revisions
744
478
        present in other, but missing from self.
745
479
        """
750
484
        common_index = min(self_len, other_len) -1
751
485
        if common_index >= 0 and \
752
486
            self_history[common_index] != other_history[common_index]:
753
 
            raise errors.DivergedBranches(self, other)
 
487
            raise DivergedBranches(self, other)
754
488
 
755
489
        if stop_revision is None:
756
490
            stop_revision = other_len
757
491
        else:
 
492
            assert isinstance(stop_revision, int)
758
493
            if stop_revision > other_len:
759
494
                raise errors.NoSuchRevision(self, stop_revision)
760
495
        return other_history[self_len:stop_revision]
761
496
 
762
 
    @needs_write_lock
763
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
764
 
                         graph=None):
 
497
    def update_revisions(self, other, stop_revision=None):
765
498
        """Pull in new perfect-fit revisions.
766
499
 
767
500
        :param other: Another Branch to pull from
768
501
        :param stop_revision: Updated until the given revision
769
 
        :param overwrite: Always set the branch pointer, rather than checking
770
 
            to see if it is a proper descendant.
771
 
        :param graph: A Graph object that can be used to query history
772
 
            information. This can be None.
773
502
        :return: None
774
503
        """
775
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
776
 
            overwrite, graph)
777
 
 
778
 
    def import_last_revision_info(self, source_repo, revno, revid):
779
 
        """Set the last revision info, importing from another repo if necessary.
780
 
 
781
 
        This is used by the bound branch code to upload a revision to
782
 
        the master branch first before updating the tip of the local branch.
783
 
 
784
 
        :param source_repo: Source repository to optionally fetch from
785
 
        :param revno: Revision number of the new tip
786
 
        :param revid: Revision id of the new tip
787
 
        """
788
 
        if not self.repository.has_same_location(source_repo):
789
 
            self.repository.fetch(source_repo, revision_id=revid)
790
 
        self.set_last_revision_info(revno, revid)
 
504
        raise NotImplementedError(self.update_revisions)
791
505
 
792
506
    def revision_id_to_revno(self, revision_id):
793
507
        """Given a revision id, return its revno"""
794
 
        if _mod_revision.is_null(revision_id):
 
508
        if revision_id is None:
795
509
            return 0
 
510
        revision_id = osutils.safe_revision_id(revision_id)
796
511
        history = self.revision_history()
797
512
        try:
798
513
            return history.index(revision_id) + 1
802
517
    def get_rev_id(self, revno, history=None):
803
518
        """Find the revision id of the specified revno."""
804
519
        if revno == 0:
805
 
            return _mod_revision.NULL_REVISION
 
520
            return None
806
521
        if history is None:
807
522
            history = self.revision_history()
808
523
        if revno <= 0 or revno > len(history):
809
524
            raise errors.NoSuchRevision(self, revno)
810
525
        return history[revno - 1]
811
526
 
812
 
    def pull(self, source, overwrite=False, stop_revision=None,
813
 
             possible_transports=None, _override_hook_target=None):
 
527
    def pull(self, source, overwrite=False, stop_revision=None):
814
528
        """Mirror source into this branch.
815
529
 
816
530
        This branch is considered to be 'local', having low latency.
830
544
        """Return `Tree` object for last revision."""
831
545
        return self.repository.revision_tree(self.last_revision())
832
546
 
 
547
    def rename_one(self, from_rel, to_rel):
 
548
        """Rename one file.
 
549
 
 
550
        This can change the directory or the filename or both.
 
551
        """
 
552
        raise NotImplementedError(self.rename_one)
 
553
 
 
554
    def move(self, from_paths, to_name):
 
555
        """Rename files.
 
556
 
 
557
        to_name must exist as a versioned directory.
 
558
 
 
559
        If to_name exists and is a directory, the files are moved into
 
560
        it, keeping their old names.  If it is a directory, 
 
561
 
 
562
        Note that to_name is only the last component of the new name;
 
563
        this doesn't change the directory.
 
564
 
 
565
        This returns a list of (from_path, to_path) pairs for each
 
566
        entry that is moved.
 
567
        """
 
568
        raise NotImplementedError(self.move)
 
569
 
833
570
    def get_parent(self):
834
571
        """Return the parent location of the branch.
835
572
 
836
 
        This is the default location for pull/missing.  The usual
 
573
        This is the default location for push/pull/missing.  The usual
837
574
        pattern is that the user can override it by specifying a
838
575
        location.
839
576
        """
840
 
        parent = self._get_parent_location()
841
 
        if parent is None:
842
 
            return parent
843
 
        # This is an old-format absolute path to a local branch
844
 
        # turn it into a url
845
 
        if parent.startswith('/'):
846
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
847
 
        try:
848
 
            return urlutils.join(self.base[:-1], parent)
849
 
        except errors.InvalidURLJoin, e:
850
 
            raise errors.InaccessibleParent(parent, self.base)
851
 
 
852
 
    def _get_parent_location(self):
853
 
        raise NotImplementedError(self._get_parent_location)
 
577
        raise NotImplementedError(self.get_parent)
854
578
 
855
579
    def _set_config_location(self, name, url, config=None,
856
580
                             make_relative=False):
860
584
            url = ''
861
585
        elif make_relative:
862
586
            url = urlutils.relative_url(self.base, url)
863
 
        config.set_user_option(name, url, warn_masked=True)
 
587
        config.set_user_option(name, url)
864
588
 
865
589
    def _get_config_location(self, name, config=None):
866
590
        if config is None:
886
610
        pattern is that the user can override it by specifying a
887
611
        location.
888
612
        """
889
 
        self.get_config().set_user_option('submit_branch', location,
890
 
            warn_masked=True)
 
613
        self.get_config().set_user_option('submit_branch', location)
891
614
 
892
615
    def get_public_branch(self):
893
616
        """Return the public location of the branch.
894
617
 
895
 
        This is used by merge directives.
 
618
        This is is used by merge directives.
896
619
        """
897
620
        return self._get_config_location('public_branch')
898
621
 
914
637
        """Set a new push location for this branch."""
915
638
        raise NotImplementedError(self.set_push_location)
916
639
 
917
 
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
918
 
        """Run the post_change_branch_tip hooks."""
919
 
        hooks = Branch.hooks['post_change_branch_tip']
920
 
        if not hooks:
921
 
            return
922
 
        new_revno, new_revid = self.last_revision_info()
923
 
        params = ChangeBranchTipParams(
924
 
            self, old_revno, new_revno, old_revid, new_revid)
925
 
        for hook in hooks:
926
 
            hook(params)
927
 
 
928
 
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
929
 
        """Run the pre_change_branch_tip hooks."""
930
 
        hooks = Branch.hooks['pre_change_branch_tip']
931
 
        if not hooks:
932
 
            return
933
 
        old_revno, old_revid = self.last_revision_info()
934
 
        params = ChangeBranchTipParams(
935
 
            self, old_revno, new_revno, old_revid, new_revid)
936
 
        for hook in hooks:
937
 
            try:
938
 
                hook(params)
939
 
            except errors.TipChangeRejected:
940
 
                raise
941
 
            except Exception:
942
 
                exc_info = sys.exc_info()
943
 
                hook_name = Branch.hooks.get_hook_name(hook)
944
 
                raise errors.HookFailed(
945
 
                    'pre_change_branch_tip', hook_name, exc_info)
946
 
 
947
640
    def set_parent(self, url):
948
641
        raise NotImplementedError(self.set_parent)
949
642
 
950
643
    @needs_write_lock
951
644
    def update(self):
952
 
        """Synchronise this branch with the master branch if any.
 
645
        """Synchronise this branch with the master branch if any. 
953
646
 
954
647
        :return: None or the last_revision pivoted out during the update.
955
648
        """
962
655
        """
963
656
        if revno != 0:
964
657
            self.check_real_revno(revno)
965
 
 
 
658
            
966
659
    def check_real_revno(self, revno):
967
660
        """\
968
661
        Check whether a revno corresponds to a real revision.
969
662
        Zero (the NULL revision) is considered invalid
970
663
        """
971
664
        if revno < 1 or revno > self.revno():
972
 
            raise errors.InvalidRevisionNumber(revno)
 
665
            raise InvalidRevisionNumber(revno)
973
666
 
974
667
    @needs_read_lock
975
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
668
    def clone(self, to_bzrdir, revision_id=None):
976
669
        """Clone this branch into to_bzrdir preserving all semantic values.
977
 
 
978
 
        Most API users will want 'create_clone_on_transport', which creates a
979
 
        new bzrdir and branch on the fly.
980
 
 
 
670
        
981
671
        revision_id: if not None, the revision history in the new branch will
982
672
                     be truncated to end with revision_id.
983
673
        """
984
 
        result = to_bzrdir.create_branch()
985
 
        if repository_policy is not None:
986
 
            repository_policy.configure_branch(result)
 
674
        result = self._format.initialize(to_bzrdir)
987
675
        self.copy_content_into(result, revision_id=revision_id)
988
676
        return  result
989
677
 
990
678
    @needs_read_lock
991
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
679
    def sprout(self, to_bzrdir, revision_id=None):
992
680
        """Create a new line of development from the branch, into to_bzrdir.
993
 
 
994
 
        to_bzrdir controls the branch format.
995
 
 
 
681
        
996
682
        revision_id: if not None, the revision history in the new branch will
997
683
                     be truncated to end with revision_id.
998
684
        """
999
 
        result = to_bzrdir.create_branch()
1000
 
        if repository_policy is not None:
1001
 
            repository_policy.configure_branch(result)
 
685
        result = self._format.initialize(to_bzrdir)
1002
686
        self.copy_content_into(result, revision_id=revision_id)
1003
687
        result.set_parent(self.bzrdir.root_transport.base)
1004
688
        return result
1007
691
        """Synchronize last revision and revision history between branches.
1008
692
 
1009
693
        This version is most efficient when the destination is also a
1010
 
        BzrBranch6, but works for BzrBranch5, as long as the destination's
1011
 
        repository contains all the lefthand ancestors of the intended
1012
 
        last_revision.  If not, set_last_revision_info will fail.
 
694
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
695
        history is the true lefthand parent history, and all of the revisions
 
696
        are in the destination's repository.  If not, set_revision_history
 
697
        will fail.
1013
698
 
1014
699
        :param destination: The branch to copy the history into
1015
700
        :param revision_id: The revision-id to truncate history at.  May
1016
701
          be None to copy complete history.
1017
702
        """
1018
 
        source_revno, source_revision_id = self.last_revision_info()
1019
 
        if revision_id is None:
1020
 
            revno, revision_id = source_revno, source_revision_id
1021
 
        elif source_revision_id == revision_id:
1022
 
            # we know the revno without needing to walk all of history
1023
 
            revno = source_revno
1024
 
        else:
1025
 
            # To figure out the revno for a random revision, we need to build
1026
 
            # the revision history, and count its length.
1027
 
            # We don't care about the order, just how long it is.
1028
 
            # Alternatively, we could start at the current location, and count
1029
 
            # backwards. But there is no guarantee that we will find it since
1030
 
            # it may be a merged revision.
1031
 
            revno = len(list(self.repository.iter_reverse_revision_history(
1032
 
                                                                revision_id)))
1033
 
        destination.set_last_revision_info(revno, revision_id)
 
703
        new_history = self.revision_history()
 
704
        if revision_id is not None:
 
705
            revision_id = osutils.safe_revision_id(revision_id)
 
706
            try:
 
707
                new_history = new_history[:new_history.index(revision_id) + 1]
 
708
            except ValueError:
 
709
                rev = self.repository.get_revision(revision_id)
 
710
                new_history = rev.get_history(self.repository)[1:]
 
711
        destination.set_revision_history(new_history)
1034
712
 
1035
713
    @needs_read_lock
1036
714
    def copy_content_into(self, destination, revision_id=None):
1047
725
        else:
1048
726
            if parent:
1049
727
                destination.set_parent(parent)
1050
 
        if self._push_should_merge_tags():
1051
 
            self.tags.merge_to(destination.tags)
 
728
        self.tags.merge_to(destination.tags)
1052
729
 
1053
730
    @needs_read_lock
1054
731
    def check(self):
1055
732
        """Check consistency of the branch.
1056
733
 
1057
734
        In particular this checks that revisions given in the revision-history
1058
 
        do actually match up in the revision graph, and that they're all
 
735
        do actually match up in the revision graph, and that they're all 
1059
736
        present in the repository.
1060
 
 
 
737
        
1061
738
        Callers will typically also want to check the repository.
1062
739
 
1063
740
        :return: A BranchCheckResult.
1064
741
        """
1065
742
        mainline_parent_id = None
1066
 
        last_revno, last_revision_id = self.last_revision_info()
1067
 
        real_rev_history = list(self.repository.iter_reverse_revision_history(
1068
 
                                last_revision_id))
1069
 
        real_rev_history.reverse()
1070
 
        if len(real_rev_history) != last_revno:
1071
 
            raise errors.BzrCheckError('revno does not match len(mainline)'
1072
 
                ' %s != %s' % (last_revno, len(real_rev_history)))
1073
 
        # TODO: We should probably also check that real_rev_history actually
1074
 
        #       matches self.revision_history()
1075
 
        for revision_id in real_rev_history:
 
743
        for revision_id in self.revision_history():
1076
744
            try:
1077
745
                revision = self.repository.get_revision(revision_id)
1078
746
            except errors.NoSuchRevision, e:
1102
770
            format.set_branch_format(self._format)
1103
771
        return format
1104
772
 
1105
 
    def create_clone_on_transport(self, to_transport, revision_id=None,
1106
 
        stacked_on=None):
1107
 
        """Create a clone of this branch and its bzrdir.
1108
 
 
1109
 
        :param to_transport: The transport to clone onto.
1110
 
        :param revision_id: The revision id to use as tip in the new branch.
1111
 
            If None the tip is obtained from this branch.
1112
 
        :param stacked_on: An optional URL to stack the clone on.
1113
 
        """
1114
 
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1115
 
        # clone call. Or something. 20090224 RBC/spiv.
1116
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1117
 
            revision_id=revision_id, stacked_on=stacked_on)
1118
 
        return dir_to.open_branch()
1119
 
 
1120
773
    def create_checkout(self, to_location, revision_id=None,
1121
 
                        lightweight=False, accelerator_tree=None,
1122
 
                        hardlink=False):
 
774
                        lightweight=False):
1123
775
        """Create a checkout of a branch.
1124
 
 
 
776
        
1125
777
        :param to_location: The url to produce the checkout at
1126
778
        :param revision_id: The revision to check out
1127
779
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1128
780
        produce a bound branch (heavyweight checkout)
1129
 
        :param accelerator_tree: A tree which can be used for retrieving file
1130
 
            contents more quickly than the revision tree, i.e. a workingtree.
1131
 
            The revision tree will be used for cases where accelerator_tree's
1132
 
            content is different.
1133
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1134
 
            where possible.
1135
781
        :return: The tree of the created checkout
1136
782
        """
1137
783
        t = transport.get_transport(to_location)
1139
785
        if lightweight:
1140
786
            format = self._get_checkout_format()
1141
787
            checkout = format.initialize_on_transport(t)
1142
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
788
            BranchReferenceFormat().initialize(checkout, self)
1143
789
        else:
1144
790
            format = self._get_checkout_format()
1145
791
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1146
792
                to_location, force_new_tree=False, format=format)
1147
793
            checkout = checkout_branch.bzrdir
1148
794
            checkout_branch.bind(self)
1149
 
            # pull up to the specified revision_id to set the initial
 
795
            # pull up to the specified revision_id to set the initial 
1150
796
            # branch tip correctly, and seed it with history.
1151
797
            checkout_branch.pull(self, stop_revision=revision_id)
1152
 
            from_branch=None
1153
 
        tree = checkout.create_workingtree(revision_id,
1154
 
                                           from_branch=from_branch,
1155
 
                                           accelerator_tree=accelerator_tree,
1156
 
                                           hardlink=hardlink)
 
798
        tree = checkout.create_workingtree(revision_id)
1157
799
        basis_tree = tree.basis_tree()
1158
800
        basis_tree.lock_read()
1159
801
        try:
1166
808
            basis_tree.unlock()
1167
809
        return tree
1168
810
 
1169
 
    @needs_write_lock
1170
 
    def reconcile(self, thorough=True):
1171
 
        """Make sure the data stored in this branch is consistent."""
1172
 
        from bzrlib.reconcile import BranchReconciler
1173
 
        reconciler = BranchReconciler(self, thorough=thorough)
1174
 
        reconciler.reconcile()
1175
 
        return reconciler
1176
 
 
1177
811
    def reference_parent(self, file_id, path):
1178
812
        """Return the parent branch for a tree-reference file_id
1179
813
        :param file_id: The file_id of the tree reference
1186
820
    def supports_tags(self):
1187
821
        return self._format.supports_tags()
1188
822
 
1189
 
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1190
 
                                         other_branch):
1191
 
        """Ensure that revision_b is a descendant of revision_a.
1192
 
 
1193
 
        This is a helper function for update_revisions.
1194
 
 
1195
 
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1196
 
        :returns: True if revision_b is a descendant of revision_a.
1197
 
        """
1198
 
        relation = self._revision_relations(revision_a, revision_b, graph)
1199
 
        if relation == 'b_descends_from_a':
1200
 
            return True
1201
 
        elif relation == 'diverged':
1202
 
            raise errors.DivergedBranches(self, other_branch)
1203
 
        elif relation == 'a_descends_from_b':
1204
 
            return False
1205
 
        else:
1206
 
            raise AssertionError("invalid relation: %r" % (relation,))
1207
 
 
1208
 
    def _revision_relations(self, revision_a, revision_b, graph):
1209
 
        """Determine the relationship between two revisions.
1210
 
 
1211
 
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1212
 
        """
1213
 
        heads = graph.heads([revision_a, revision_b])
1214
 
        if heads == set([revision_b]):
1215
 
            return 'b_descends_from_a'
1216
 
        elif heads == set([revision_a, revision_b]):
1217
 
            # These branches have diverged
1218
 
            return 'diverged'
1219
 
        elif heads == set([revision_a]):
1220
 
            return 'a_descends_from_b'
1221
 
        else:
1222
 
            raise AssertionError("invalid heads: %r" % (heads,))
1223
 
 
1224
823
 
1225
824
class BranchFormat(object):
1226
825
    """An encapsulation of the initialization and open routines for a format.
1230
829
     * a format string,
1231
830
     * an open routine.
1232
831
 
1233
 
    Formats are placed in an dict by their format string for reference
 
832
    Formats are placed in an dict by their format string for reference 
1234
833
    during branch opening. Its not required that these be instances, they
1235
 
    can be classes themselves with class methods - it simply depends on
 
834
    can be classes themselves with class methods - it simply depends on 
1236
835
    whether state is needed for a given format or not.
1237
836
 
1238
837
    Once a format is deprecated, just deprecate the initialize and open
1239
 
    methods on the format class. Do not deprecate the object, as the
 
838
    methods on the format class. Do not deprecate the object, as the 
1240
839
    object will be created every time regardless.
1241
840
    """
1242
841
 
1259
858
            transport = a_bzrdir.get_branch_transport(None)
1260
859
            format_string = transport.get("format").read()
1261
860
            return klass._formats[format_string]
1262
 
        except errors.NoSuchFile:
1263
 
            raise errors.NotBranchError(path=transport.base)
 
861
        except NoSuchFile:
 
862
            raise NotBranchError(path=transport.base)
1264
863
        except KeyError:
1265
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
864
            raise errors.UnknownFormatError(format=format_string)
1266
865
 
1267
866
    @classmethod
1268
867
    def get_default_format(klass):
1281
880
        """
1282
881
        return None
1283
882
 
1284
 
    @classmethod
1285
 
    def set_reference(self, a_bzrdir, to_branch):
1286
 
        """Set the target reference of the branch in a_bzrdir.
1287
 
 
1288
 
        format probing must have been completed before calling
1289
 
        this method - it is assumed that the format of the branch
1290
 
        in a_bzrdir is correct.
1291
 
 
1292
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
1293
 
        :param to_branch: branch that the checkout is to reference
1294
 
        """
1295
 
        raise NotImplementedError(self.set_reference)
1296
 
 
1297
883
    def get_format_string(self):
1298
884
        """Return the ASCII format string that identifies this format."""
1299
885
        raise NotImplementedError(self.get_format_string)
1326
912
        control_files.create_lock()
1327
913
        control_files.lock_write()
1328
914
        if set_format:
1329
 
            utf8_files += [('format', self.get_format_string())]
 
915
            control_files.put_utf8('format', self.get_format_string())
1330
916
        try:
1331
 
            for (filename, content) in utf8_files:
1332
 
                branch_transport.put_bytes(
1333
 
                    filename, content,
1334
 
                    mode=a_bzrdir._get_file_mode())
 
917
            for file, content in utf8_files:
 
918
                control_files.put_utf8(file, content)
1335
919
        finally:
1336
920
            control_files.unlock()
1337
921
        return self.open(a_bzrdir, _found=True)
1344
928
        """Is this format supported?
1345
929
 
1346
930
        Supported formats can be initialized and opened.
1347
 
        Unsupported formats may not support initialization or committing or
 
931
        Unsupported formats may not support initialization or committing or 
1348
932
        some other features depending on the reason for not being supported.
1349
933
        """
1350
934
        return True
1351
935
 
1352
 
    def make_tags(self, branch):
1353
 
        """Create a tags object for branch.
1354
 
 
1355
 
        This method is on BranchFormat, because BranchFormats are reflected
1356
 
        over the wire via network_name(), whereas full Branch instances require
1357
 
        multiple VFS method calls to operate at all.
1358
 
 
1359
 
        The default implementation returns a disabled-tags instance.
1360
 
 
1361
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1362
 
        on a RemoteBranch.
1363
 
        """
1364
 
        return DisabledTags(branch)
1365
 
 
1366
 
    def network_name(self):
1367
 
        """A simple byte string uniquely identifying this format for RPC calls.
1368
 
 
1369
 
        MetaDir branch formats use their disk format string to identify the
1370
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1371
 
        foreign formats like svn/git and hg should use some marker which is
1372
 
        unique and immutable.
1373
 
        """
1374
 
        raise NotImplementedError(self.network_name)
1375
 
 
1376
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
936
    def open(self, a_bzrdir, _found=False):
1377
937
        """Return the branch object for a_bzrdir
1378
938
 
1379
 
        :param a_bzrdir: A BzrDir that contains a branch.
1380
 
        :param _found: a private parameter, do not use it. It is used to
1381
 
            indicate if format probing has already be done.
1382
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1383
 
            (if there are any).  Default is to open fallbacks.
 
939
        _found is a private parameter, do not use it. It is used to indicate
 
940
               if format probing has already be done.
1384
941
        """
1385
942
        raise NotImplementedError(self.open)
1386
943
 
1387
944
    @classmethod
1388
945
    def register_format(klass, format):
1389
 
        """Register a metadir format."""
1390
946
        klass._formats[format.get_format_string()] = format
1391
 
        # Metadir formats have a network name of their format string, and get
1392
 
        # registered as class factories.
1393
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1394
947
 
1395
948
    @classmethod
1396
949
    def set_default_format(klass, format):
1397
950
        klass._default_format = format
1398
951
 
1399
 
    def supports_stacking(self):
1400
 
        """True if this format records a stacked-on branch."""
1401
 
        return False
1402
 
 
1403
952
    @classmethod
1404
953
    def unregister_format(klass, format):
 
954
        assert klass._formats[format.get_format_string()] is format
1405
955
        del klass._formats[format.get_format_string()]
1406
956
 
1407
957
    def __str__(self):
1408
 
        return self.get_format_description().rstrip()
 
958
        return self.get_format_string().rstrip()
1409
959
 
1410
960
    def supports_tags(self):
1411
961
        """True if this format supports tags stored in the branch"""
1412
962
        return False  # by default
1413
963
 
 
964
    # XXX: Probably doesn't really belong here -- mbp 20070212
 
965
    def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
 
966
            lock_class):
 
967
        branch_transport = a_bzrdir.get_branch_transport(self)
 
968
        control_files = lockable_files.LockableFiles(branch_transport,
 
969
            lock_filename, lock_class)
 
970
        control_files.create_lock()
 
971
        control_files.lock_write()
 
972
        try:
 
973
            for filename, content in utf8_files:
 
974
                control_files.put_utf8(filename, content)
 
975
        finally:
 
976
            control_files.unlock()
 
977
 
1414
978
 
1415
979
class BranchHooks(Hooks):
1416
980
    """A dictionary mapping hook name to a list of callables for branch hooks.
1417
 
 
 
981
    
1418
982
    e.g. ['set_rh'] Is the list of items to be called when the
1419
983
    set_revision_history function is invoked.
1420
984
    """
1426
990
        notified.
1427
991
        """
1428
992
        Hooks.__init__(self)
1429
 
        self.create_hook(HookPoint('set_rh',
1430
 
            "Invoked whenever the revision history has been set via "
1431
 
            "set_revision_history. The api signature is (branch, "
1432
 
            "revision_history), and the branch will be write-locked. "
1433
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1434
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1435
 
        self.create_hook(HookPoint('open',
1436
 
            "Called with the Branch object that has been opened after a "
1437
 
            "branch is opened.", (1, 8), None))
1438
 
        self.create_hook(HookPoint('post_push',
1439
 
            "Called after a push operation completes. post_push is called "
1440
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1441
 
            "bzr client.", (0, 15), None))
1442
 
        self.create_hook(HookPoint('post_pull',
1443
 
            "Called after a pull operation completes. post_pull is called "
1444
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1445
 
            "bzr client.", (0, 15), None))
1446
 
        self.create_hook(HookPoint('pre_commit',
1447
 
            "Called after a commit is calculated but before it is is "
1448
 
            "completed. pre_commit is called with (local, master, old_revno, "
1449
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1450
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1451
 
            "tree_delta is a TreeDelta object describing changes from the "
1452
 
            "basis revision. hooks MUST NOT modify this delta. "
1453
 
            " future_tree is an in-memory tree obtained from "
1454
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1455
 
            "tree.", (0,91), None))
1456
 
        self.create_hook(HookPoint('post_commit',
1457
 
            "Called in the bzr client after a commit has completed. "
1458
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1459
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1460
 
            "commit to a branch.", (0, 15), None))
1461
 
        self.create_hook(HookPoint('post_uncommit',
1462
 
            "Called in the bzr client after an uncommit completes. "
1463
 
            "post_uncommit is called with (local, master, old_revno, "
1464
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1465
 
            "or None, master is the target branch, and an empty branch "
1466
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1467
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1468
 
            "Called in bzr client and server before a change to the tip of a "
1469
 
            "branch is made. pre_change_branch_tip is called with a "
1470
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1471
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1472
 
        self.create_hook(HookPoint('post_change_branch_tip',
1473
 
            "Called in bzr client and server after a change to the tip of a "
1474
 
            "branch is made. post_change_branch_tip is called with a "
1475
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1476
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1477
 
        self.create_hook(HookPoint('transform_fallback_location',
1478
 
            "Called when a stacked branch is activating its fallback "
1479
 
            "locations. transform_fallback_location is called with (branch, "
1480
 
            "url), and should return a new url. Returning the same url "
1481
 
            "allows it to be used as-is, returning a different one can be "
1482
 
            "used to cause the branch to stack on a closer copy of that "
1483
 
            "fallback_location. Note that the branch cannot have history "
1484
 
            "accessing methods called on it during this hook because the "
1485
 
            "fallback locations have not been activated. When there are "
1486
 
            "multiple hooks installed for transform_fallback_location, "
1487
 
            "all are called with the url returned from the previous hook."
1488
 
            "The order is however undefined.", (1, 9), None))
 
993
        # Introduced in 0.15:
 
994
        # invoked whenever the revision history has been set
 
995
        # with set_revision_history. The api signature is
 
996
        # (branch, revision_history), and the branch will
 
997
        # be write-locked.
 
998
        self['set_rh'] = []
 
999
        # invoked after a push operation completes.
 
1000
        # the api signature is
 
1001
        # (push_result)
 
1002
        # containing the members
 
1003
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1004
        # where local is the local target branch or None, master is the target 
 
1005
        # master branch, and the rest should be self explanatory. The source
 
1006
        # is read locked and the target branches write locked. Source will
 
1007
        # be the local low-latency branch.
 
1008
        self['post_push'] = []
 
1009
        # invoked after a pull operation completes.
 
1010
        # the api signature is
 
1011
        # (pull_result)
 
1012
        # containing the members
 
1013
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1014
        # where local is the local branch or None, master is the target 
 
1015
        # master branch, and the rest should be self explanatory. The source
 
1016
        # is read locked and the target branches write locked. The local
 
1017
        # branch is the low-latency branch.
 
1018
        self['post_pull'] = []
 
1019
        # invoked after a commit operation completes.
 
1020
        # the api signature is 
 
1021
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1022
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1023
        self['post_commit'] = []
 
1024
        # invoked after a uncommit operation completes.
 
1025
        # the api signature is
 
1026
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1027
        # local is the local branch or None, master is the target branch,
 
1028
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1029
        self['post_uncommit'] = []
1489
1030
 
1490
1031
 
1491
1032
# install the default hooks into the Branch class.
1492
1033
Branch.hooks = BranchHooks()
1493
1034
 
1494
1035
 
1495
 
class ChangeBranchTipParams(object):
1496
 
    """Object holding parameters passed to *_change_branch_tip hooks.
1497
 
 
1498
 
    There are 5 fields that hooks may wish to access:
1499
 
 
1500
 
    :ivar branch: the branch being changed
1501
 
    :ivar old_revno: revision number before the change
1502
 
    :ivar new_revno: revision number after the change
1503
 
    :ivar old_revid: revision id before the change
1504
 
    :ivar new_revid: revision id after the change
1505
 
 
1506
 
    The revid fields are strings. The revno fields are integers.
1507
 
    """
1508
 
 
1509
 
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1510
 
        """Create a group of ChangeBranchTip parameters.
1511
 
 
1512
 
        :param branch: The branch being changed.
1513
 
        :param old_revno: Revision number before the change.
1514
 
        :param new_revno: Revision number after the change.
1515
 
        :param old_revid: Tip revision id before the change.
1516
 
        :param new_revid: Tip revision id after the change.
1517
 
        """
1518
 
        self.branch = branch
1519
 
        self.old_revno = old_revno
1520
 
        self.new_revno = new_revno
1521
 
        self.old_revid = old_revid
1522
 
        self.new_revid = new_revid
1523
 
 
1524
 
    def __eq__(self, other):
1525
 
        return self.__dict__ == other.__dict__
1526
 
 
1527
 
    def __repr__(self):
1528
 
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1529
 
            self.__class__.__name__, self.branch,
1530
 
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1531
 
 
1532
 
 
1533
1036
class BzrBranchFormat4(BranchFormat):
1534
1037
    """Bzr branch format 4.
1535
1038
 
1554
1057
        super(BzrBranchFormat4, self).__init__()
1555
1058
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1556
1059
 
1557
 
    def network_name(self):
1558
 
        """The network name for this format is the control dirs disk label."""
1559
 
        return self._matchingbzrdir.get_format_string()
 
1060
    def open(self, a_bzrdir, _found=False):
 
1061
        """Return the branch object for a_bzrdir
1560
1062
 
1561
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1562
 
        """See BranchFormat.open()."""
 
1063
        _found is a private parameter, do not use it. It is used to indicate
 
1064
               if format probing has already be done.
 
1065
        """
1563
1066
        if not _found:
1564
1067
            # we are being called directly and must probe.
1565
1068
            raise NotImplementedError
1572
1075
        return "Bazaar-NG branch format 4"
1573
1076
 
1574
1077
 
1575
 
class BranchFormatMetadir(BranchFormat):
1576
 
    """Common logic for meta-dir based branch formats."""
1577
 
 
1578
 
    def _branch_class(self):
1579
 
        """What class to instantiate on open calls."""
1580
 
        raise NotImplementedError(self._branch_class)
1581
 
 
1582
 
    def network_name(self):
1583
 
        """A simple byte string uniquely identifying this format for RPC calls.
1584
 
 
1585
 
        Metadir branch formats use their format string.
 
1078
class BzrBranchFormat5(BranchFormat):
 
1079
    """Bzr branch format 5.
 
1080
 
 
1081
    This format has:
 
1082
     - a revision-history file.
 
1083
     - a format string
 
1084
     - a lock dir guarding the branch itself
 
1085
     - all of this stored in a branch/ subdirectory
 
1086
     - works with shared repositories.
 
1087
 
 
1088
    This format is new in bzr 0.8.
 
1089
    """
 
1090
 
 
1091
    def get_format_string(self):
 
1092
        """See BranchFormat.get_format_string()."""
 
1093
        return "Bazaar-NG branch format 5\n"
 
1094
 
 
1095
    def get_format_description(self):
 
1096
        """See BranchFormat.get_format_description()."""
 
1097
        return "Branch format 5"
 
1098
        
 
1099
    def initialize(self, a_bzrdir):
 
1100
        """Create a branch of this format in a_bzrdir."""
 
1101
        utf8_files = [('revision-history', ''),
 
1102
                      ('branch-name', ''),
 
1103
                      ]
 
1104
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1105
 
 
1106
    def __init__(self):
 
1107
        super(BzrBranchFormat5, self).__init__()
 
1108
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1109
 
 
1110
    def open(self, a_bzrdir, _found=False):
 
1111
        """Return the branch object for a_bzrdir
 
1112
 
 
1113
        _found is a private parameter, do not use it. It is used to indicate
 
1114
               if format probing has already be done.
1586
1115
        """
1587
 
        return self.get_format_string()
1588
 
 
1589
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1590
 
        """See BranchFormat.open()."""
1591
1116
        if not _found:
1592
1117
            format = BranchFormat.find_format(a_bzrdir)
1593
 
            if format.__class__ != self.__class__:
1594
 
                raise AssertionError("wrong format %r found for %r" %
1595
 
                    (format, self))
 
1118
            assert format.__class__ == self.__class__
1596
1119
        try:
1597
1120
            transport = a_bzrdir.get_branch_transport(None)
1598
1121
            control_files = lockable_files.LockableFiles(transport, 'lock',
1599
1122
                                                         lockdir.LockDir)
1600
 
            return self._branch_class()(_format=self,
 
1123
            return BzrBranch5(_format=self,
1601
1124
                              _control_files=control_files,
1602
1125
                              a_bzrdir=a_bzrdir,
1603
 
                              _repository=a_bzrdir.find_repository(),
1604
 
                              ignore_fallbacks=ignore_fallbacks)
1605
 
        except errors.NoSuchFile:
1606
 
            raise errors.NotBranchError(path=transport.base)
1607
 
 
1608
 
    def __init__(self):
1609
 
        super(BranchFormatMetadir, self).__init__()
1610
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1611
 
        self._matchingbzrdir.set_branch_format(self)
1612
 
 
1613
 
    def supports_tags(self):
1614
 
        return True
1615
 
 
1616
 
 
1617
 
class BzrBranchFormat5(BranchFormatMetadir):
1618
 
    """Bzr branch format 5.
1619
 
 
1620
 
    This format has:
1621
 
     - a revision-history file.
1622
 
     - a format string
1623
 
     - a lock dir guarding the branch itself
1624
 
     - all of this stored in a branch/ subdirectory
1625
 
     - works with shared repositories.
1626
 
 
1627
 
    This format is new in bzr 0.8.
1628
 
    """
1629
 
 
1630
 
    def _branch_class(self):
1631
 
        return BzrBranch5
1632
 
 
1633
 
    def get_format_string(self):
1634
 
        """See BranchFormat.get_format_string()."""
1635
 
        return "Bazaar-NG branch format 5\n"
1636
 
 
1637
 
    def get_format_description(self):
1638
 
        """See BranchFormat.get_format_description()."""
1639
 
        return "Branch format 5"
1640
 
 
1641
 
    def initialize(self, a_bzrdir):
1642
 
        """Create a branch of this format in a_bzrdir."""
1643
 
        utf8_files = [('revision-history', ''),
1644
 
                      ('branch-name', ''),
1645
 
                      ]
1646
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1647
 
 
1648
 
    def supports_tags(self):
1649
 
        return False
1650
 
 
1651
 
 
1652
 
class BzrBranchFormat6(BranchFormatMetadir):
1653
 
    """Branch format with last-revision and tags.
 
1126
                              _repository=a_bzrdir.find_repository())
 
1127
        except NoSuchFile:
 
1128
            raise NotBranchError(path=transport.base)
 
1129
 
 
1130
 
 
1131
class BzrBranchFormat6(BzrBranchFormat5):
 
1132
    """Branch format with last-revision
1654
1133
 
1655
1134
    Unlike previous formats, this has no explicit revision history. Instead,
1656
1135
    this just stores the last-revision, and the left-hand history leading
1657
1136
    up to there is the history.
1658
1137
 
1659
1138
    This format was introduced in bzr 0.15
1660
 
    and became the default in 0.91.
1661
1139
    """
1662
1140
 
1663
 
    def _branch_class(self):
1664
 
        return BzrBranch6
1665
 
 
1666
1141
    def get_format_string(self):
1667
1142
        """See BranchFormat.get_format_string()."""
1668
1143
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
1674
1149
    def initialize(self, a_bzrdir):
1675
1150
        """Create a branch of this format in a_bzrdir."""
1676
1151
        utf8_files = [('last-revision', '0 null:\n'),
1677
 
                      ('branch.conf', ''),
1678
 
                      ('tags', ''),
1679
 
                      ]
1680
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1681
 
 
1682
 
    def make_tags(self, branch):
1683
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1684
 
        return BasicTags(branch)
1685
 
 
1686
 
 
1687
 
 
1688
 
class BzrBranchFormat7(BranchFormatMetadir):
1689
 
    """Branch format with last-revision, tags, and a stacked location pointer.
1690
 
 
1691
 
    The stacked location pointer is passed down to the repository and requires
1692
 
    a repository format with supports_external_lookups = True.
1693
 
 
1694
 
    This format was introduced in bzr 1.6.
1695
 
    """
1696
 
 
1697
 
    def _branch_class(self):
1698
 
        return BzrBranch7
1699
 
 
1700
 
    def get_format_string(self):
1701
 
        """See BranchFormat.get_format_string()."""
1702
 
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1703
 
 
1704
 
    def get_format_description(self):
1705
 
        """See BranchFormat.get_format_description()."""
1706
 
        return "Branch format 7"
1707
 
 
1708
 
    def initialize(self, a_bzrdir):
1709
 
        """Create a branch of this format in a_bzrdir."""
1710
 
        utf8_files = [('last-revision', '0 null:\n'),
1711
 
                      ('branch.conf', ''),
1712
 
                      ('tags', ''),
1713
 
                      ]
1714
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1715
 
 
1716
 
    def __init__(self):
1717
 
        super(BzrBranchFormat7, self).__init__()
1718
 
        self._matchingbzrdir.repository_format = \
1719
 
            RepositoryFormatKnitPack5RichRoot()
1720
 
 
1721
 
    def make_tags(self, branch):
1722
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1723
 
        return BasicTags(branch)
1724
 
 
1725
 
    def supports_stacking(self):
 
1152
                      ('branch-name', ''),
 
1153
                      ('branch.conf', ''),
 
1154
                      ('tags', ''),
 
1155
                      ]
 
1156
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1157
 
 
1158
    def open(self, a_bzrdir, _found=False):
 
1159
        """Return the branch object for a_bzrdir
 
1160
 
 
1161
        _found is a private parameter, do not use it. It is used to indicate
 
1162
               if format probing has already be done.
 
1163
        """
 
1164
        if not _found:
 
1165
            format = BranchFormat.find_format(a_bzrdir)
 
1166
            assert format.__class__ == self.__class__
 
1167
        transport = a_bzrdir.get_branch_transport(None)
 
1168
        control_files = lockable_files.LockableFiles(transport, 'lock',
 
1169
                                                     lockdir.LockDir)
 
1170
        return BzrBranch6(_format=self,
 
1171
                          _control_files=control_files,
 
1172
                          a_bzrdir=a_bzrdir,
 
1173
                          _repository=a_bzrdir.find_repository())
 
1174
 
 
1175
    def supports_tags(self):
1726
1176
        return True
1727
1177
 
1728
1178
 
1744
1194
    def get_format_description(self):
1745
1195
        """See BranchFormat.get_format_description()."""
1746
1196
        return "Checkout reference format 1"
1747
 
 
 
1197
        
1748
1198
    def get_reference(self, a_bzrdir):
1749
1199
        """See BranchFormat.get_reference()."""
1750
1200
        transport = a_bzrdir.get_branch_transport(None)
1751
1201
        return transport.get('location').read()
1752
1202
 
1753
 
    def set_reference(self, a_bzrdir, to_branch):
1754
 
        """See BranchFormat.set_reference()."""
1755
 
        transport = a_bzrdir.get_branch_transport(None)
1756
 
        location = transport.put_bytes('location', to_branch.base)
1757
 
 
1758
1203
    def initialize(self, a_bzrdir, target_branch=None):
1759
1204
        """Create a branch of this format in a_bzrdir."""
1760
1205
        if target_branch is None:
1766
1211
        branch_transport.put_bytes('location',
1767
1212
            target_branch.bzrdir.root_transport.base)
1768
1213
        branch_transport.put_bytes('format', self.get_format_string())
1769
 
        return self.open(
1770
 
            a_bzrdir, _found=True,
1771
 
            possible_transports=[target_branch.bzrdir.root_transport])
 
1214
        return self.open(a_bzrdir, _found=True)
1772
1215
 
1773
1216
    def __init__(self):
1774
1217
        super(BranchReferenceFormat, self).__init__()
1775
1218
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1776
 
        self._matchingbzrdir.set_branch_format(self)
1777
1219
 
1778
1220
    def _make_reference_clone_function(format, a_branch):
1779
1221
        """Create a clone() routine for a branch dynamically."""
1780
 
        def clone(to_bzrdir, revision_id=None,
1781
 
            repository_policy=None):
 
1222
        def clone(to_bzrdir, revision_id=None):
1782
1223
            """See Branch.clone()."""
1783
1224
            return format.initialize(to_bzrdir, a_branch)
1784
1225
            # cannot obey revision_id limits when cloning a reference ...
1786
1227
            # emit some sort of warning/error to the caller ?!
1787
1228
        return clone
1788
1229
 
1789
 
    def open(self, a_bzrdir, _found=False, location=None,
1790
 
             possible_transports=None, ignore_fallbacks=False):
 
1230
    def open(self, a_bzrdir, _found=False, location=None):
1791
1231
        """Return the branch that the branch reference in a_bzrdir points at.
1792
1232
 
1793
 
        :param a_bzrdir: A BzrDir that contains a branch.
1794
 
        :param _found: a private parameter, do not use it. It is used to
1795
 
            indicate if format probing has already be done.
1796
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1797
 
            (if there are any).  Default is to open fallbacks.
1798
 
        :param location: The location of the referenced branch.  If
1799
 
            unspecified, this will be determined from the branch reference in
1800
 
            a_bzrdir.
1801
 
        :param possible_transports: An optional reusable transports list.
 
1233
        _found is a private parameter, do not use it. It is used to indicate
 
1234
               if format probing has already be done.
1802
1235
        """
1803
1236
        if not _found:
1804
1237
            format = BranchFormat.find_format(a_bzrdir)
1805
 
            if format.__class__ != self.__class__:
1806
 
                raise AssertionError("wrong format %r found for %r" %
1807
 
                    (format, self))
 
1238
            assert format.__class__ == self.__class__
1808
1239
        if location is None:
1809
1240
            location = self.get_reference(a_bzrdir)
1810
 
        real_bzrdir = bzrdir.BzrDir.open(
1811
 
            location, possible_transports=possible_transports)
1812
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
1241
        real_bzrdir = bzrdir.BzrDir.open(location)
 
1242
        result = real_bzrdir.open_branch()
1813
1243
        # this changes the behaviour of result.clone to create a new reference
1814
1244
        # rather than a copy of the content of the branch.
1815
1245
        # I did not use a proxy object because that needs much more extensive
1822
1252
        return result
1823
1253
 
1824
1254
 
1825
 
network_format_registry = registry.FormatRegistry()
1826
 
"""Registry of formats indexed by their network name.
1827
 
 
1828
 
The network name for a branch format is an identifier that can be used when
1829
 
referring to formats with smart server operations. See
1830
 
BranchFormat.network_name() for more detail.
1831
 
"""
1832
 
 
1833
 
 
1834
1255
# formats which have no format string are not discoverable
1835
1256
# and not independently creatable, so are not registered.
1836
 
__format5 = BzrBranchFormat5()
1837
 
__format6 = BzrBranchFormat6()
1838
 
__format7 = BzrBranchFormat7()
1839
 
BranchFormat.register_format(__format5)
 
1257
__default_format = BzrBranchFormat5()
 
1258
BranchFormat.register_format(__default_format)
1840
1259
BranchFormat.register_format(BranchReferenceFormat())
1841
 
BranchFormat.register_format(__format6)
1842
 
BranchFormat.register_format(__format7)
1843
 
BranchFormat.set_default_format(__format6)
 
1260
BranchFormat.register_format(BzrBranchFormat6())
 
1261
BranchFormat.set_default_format(__default_format)
1844
1262
_legacy_formats = [BzrBranchFormat4(),
1845
 
    ]
1846
 
network_format_registry.register(
1847
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1848
 
 
 
1263
                   ]
1849
1264
 
1850
1265
class BzrBranch(Branch):
1851
1266
    """A branch stored in the actual filesystem.
1853
1268
    Note that it's "local" in the context of the filesystem; it doesn't
1854
1269
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1855
1270
    it's writable, and can be accessed via the normal filesystem API.
1856
 
 
1857
 
    :ivar _transport: Transport for file operations on this branch's
1858
 
        control files, typically pointing to the .bzr/branch directory.
1859
 
    :ivar repository: Repository for this branch.
1860
 
    :ivar base: The url of the base directory for this branch; the one
1861
 
        containing the .bzr directory.
1862
1271
    """
1863
 
 
 
1272
    
1864
1273
    def __init__(self, _format=None,
1865
 
                 _control_files=None, a_bzrdir=None, _repository=None,
1866
 
                 ignore_fallbacks=False):
 
1274
                 _control_files=None, a_bzrdir=None, _repository=None):
1867
1275
        """Create new branch object at a particular location."""
 
1276
        Branch.__init__(self)
1868
1277
        if a_bzrdir is None:
1869
1278
            raise ValueError('a_bzrdir must be supplied')
1870
1279
        else:
1871
1280
            self.bzrdir = a_bzrdir
 
1281
        # self._transport used to point to the directory containing the
 
1282
        # control directory, but was not used - now it's just the transport
 
1283
        # for the branch control files.  mbp 20070212
1872
1284
        self._base = self.bzrdir.transport.clone('..').base
1873
 
        # XXX: We should be able to just do
1874
 
        #   self.base = self.bzrdir.root_transport.base
1875
 
        # but this does not quite work yet -- mbp 20080522
1876
1285
        self._format = _format
1877
1286
        if _control_files is None:
1878
1287
            raise ValueError('BzrBranch _control_files is None')
1879
1288
        self.control_files = _control_files
1880
1289
        self._transport = _control_files._transport
1881
1290
        self.repository = _repository
1882
 
        Branch.__init__(self)
1883
1291
 
1884
1292
    def __str__(self):
1885
1293
        return '%s(%r)' % (self.__class__.__name__, self.base)
1892
1300
 
1893
1301
    base = property(_get_base, doc="The URL for the root of this branch.")
1894
1302
 
1895
 
    def _get_config(self):
1896
 
        return TransportConfig(self._transport, 'branch.conf')
 
1303
    def abspath(self, name):
 
1304
        """See Branch.abspath."""
 
1305
        return self.control_files._transport.abspath(name)
 
1306
 
 
1307
 
 
1308
    @deprecated_method(zero_sixteen)
 
1309
    @needs_read_lock
 
1310
    def get_root_id(self):
 
1311
        """See Branch.get_root_id."""
 
1312
        tree = self.repository.revision_tree(self.last_revision())
 
1313
        return tree.inventory.root.file_id
1897
1314
 
1898
1315
    def is_locked(self):
1899
1316
        return self.control_files.is_locked()
1924
1341
        if not self.control_files.is_locked():
1925
1342
            # we just released the lock
1926
1343
            self._clear_cached_state()
1927
 
 
 
1344
        
1928
1345
    def peek_lock_mode(self):
1929
1346
        if self.control_files._lock_count == 0:
1930
1347
            return None
1939
1356
        """See Branch.print_file."""
1940
1357
        return self.repository.print_file(file, revision_id)
1941
1358
 
 
1359
    @needs_write_lock
 
1360
    def append_revision(self, *revision_ids):
 
1361
        """See Branch.append_revision."""
 
1362
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
1363
        for revision_id in revision_ids:
 
1364
            _mod_revision.check_not_reserved_id(revision_id)
 
1365
            mutter("add {%s} to revision-history" % revision_id)
 
1366
        rev_history = self.revision_history()
 
1367
        rev_history.extend(revision_ids)
 
1368
        self.set_revision_history(rev_history)
 
1369
 
1942
1370
    def _write_revision_history(self, history):
1943
1371
        """Factored out of set_revision_history.
1944
1372
 
1945
1373
        This performs the actual writing to disk.
1946
1374
        It is intended to be called by BzrBranch5.set_revision_history."""
1947
 
        self._transport.put_bytes(
1948
 
            'revision-history', '\n'.join(history),
1949
 
            mode=self.bzrdir._get_file_mode())
 
1375
        self.control_files.put_bytes(
 
1376
            'revision-history', '\n'.join(history))
1950
1377
 
1951
1378
    @needs_write_lock
1952
1379
    def set_revision_history(self, rev_history):
1953
1380
        """See Branch.set_revision_history."""
1954
 
        if 'evil' in debug.debug_flags:
1955
 
            mutter_callsite(3, "set_revision_history scales with history.")
1956
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
1957
 
        for rev_id in rev_history:
1958
 
            check_not_reserved_id(rev_id)
1959
 
        if Branch.hooks['post_change_branch_tip']:
1960
 
            # Don't calculate the last_revision_info() if there are no hooks
1961
 
            # that will use it.
1962
 
            old_revno, old_revid = self.last_revision_info()
1963
 
        if len(rev_history) == 0:
1964
 
            revid = _mod_revision.NULL_REVISION
1965
 
        else:
1966
 
            revid = rev_history[-1]
1967
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
1381
        rev_history = [osutils.safe_revision_id(r) for r in rev_history]
 
1382
        self._clear_cached_state()
1968
1383
        self._write_revision_history(rev_history)
1969
 
        self._clear_cached_state()
1970
1384
        self._cache_revision_history(rev_history)
1971
1385
        for hook in Branch.hooks['set_rh']:
1972
1386
            hook(self, rev_history)
1973
 
        if Branch.hooks['post_change_branch_tip']:
1974
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1975
 
 
1976
 
    def _synchronize_history(self, destination, revision_id):
1977
 
        """Synchronize last revision and revision history between branches.
1978
 
 
1979
 
        This version is most efficient when the destination is also a
1980
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
1981
 
        history is the true lefthand parent history, and all of the revisions
1982
 
        are in the destination's repository.  If not, set_revision_history
1983
 
        will fail.
1984
 
 
1985
 
        :param destination: The branch to copy the history into
1986
 
        :param revision_id: The revision-id to truncate history at.  May
1987
 
          be None to copy complete history.
1988
 
        """
1989
 
        if not isinstance(destination._format, BzrBranchFormat5):
1990
 
            super(BzrBranch, self)._synchronize_history(
1991
 
                destination, revision_id)
1992
 
            return
1993
 
        if revision_id == _mod_revision.NULL_REVISION:
1994
 
            new_history = []
1995
 
        else:
1996
 
            new_history = self.revision_history()
1997
 
        if revision_id is not None and new_history != []:
1998
 
            try:
1999
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2000
 
            except ValueError:
2001
 
                rev = self.repository.get_revision(revision_id)
2002
 
                new_history = rev.get_history(self.repository)[1:]
2003
 
        destination.set_revision_history(new_history)
2004
1387
 
2005
1388
    @needs_write_lock
2006
1389
    def set_last_revision_info(self, revno, revision_id):
2007
 
        """Set the last revision of this branch.
2008
 
 
2009
 
        The caller is responsible for checking that the revno is correct
2010
 
        for this revision id.
2011
 
 
2012
 
        It may be possible to set the branch last revision to an id not
2013
 
        present in the repository.  However, branches can also be
2014
 
        configured to check constraints on history, in which case this may not
2015
 
        be permitted.
2016
 
        """
2017
 
        revision_id = _mod_revision.ensure_null(revision_id)
2018
 
        # this old format stores the full history, but this api doesn't
2019
 
        # provide it, so we must generate, and might as well check it's
2020
 
        # correct
 
1390
        revision_id = osutils.safe_revision_id(revision_id)
2021
1391
        history = self._lefthand_history(revision_id)
2022
 
        if len(history) != revno:
2023
 
            raise AssertionError('%d != %d' % (len(history), revno))
 
1392
        assert len(history) == revno, '%d != %d' % (len(history), revno)
2024
1393
        self.set_revision_history(history)
2025
1394
 
2026
1395
    def _gen_revision_history(self):
2027
 
        history = self._transport.get_bytes('revision-history').split('\n')
 
1396
        history = self.control_files.get('revision-history').read().split('\n')
2028
1397
        if history[-1:] == ['']:
2029
1398
            # There shouldn't be a trailing newline, but just in case.
2030
1399
            history.pop()
2031
1400
        return history
2032
1401
 
 
1402
    def _lefthand_history(self, revision_id, last_rev=None,
 
1403
                          other_branch=None):
 
1404
        # stop_revision must be a descendant of last_revision
 
1405
        stop_graph = self.repository.get_revision_graph(revision_id)
 
1406
        if last_rev is not None and last_rev not in stop_graph:
 
1407
            # our previous tip is not merged into stop_revision
 
1408
            raise errors.DivergedBranches(self, other_branch)
 
1409
        # make a new revision history from the graph
 
1410
        current_rev_id = revision_id
 
1411
        new_history = []
 
1412
        while current_rev_id not in (None, _mod_revision.NULL_REVISION):
 
1413
            new_history.append(current_rev_id)
 
1414
            current_rev_id_parents = stop_graph[current_rev_id]
 
1415
            try:
 
1416
                current_rev_id = current_rev_id_parents[0]
 
1417
            except IndexError:
 
1418
                current_rev_id = None
 
1419
        new_history.reverse()
 
1420
        return new_history
 
1421
 
2033
1422
    @needs_write_lock
2034
1423
    def generate_revision_history(self, revision_id, last_rev=None,
2035
1424
        other_branch=None):
2041
1430
        :param other_branch: The other branch that DivergedBranches should
2042
1431
            raise with respect to.
2043
1432
        """
 
1433
        revision_id = osutils.safe_revision_id(revision_id)
2044
1434
        self.set_revision_history(self._lefthand_history(revision_id,
2045
1435
            last_rev, other_branch))
2046
1436
 
 
1437
    @needs_write_lock
 
1438
    def update_revisions(self, other, stop_revision=None):
 
1439
        """See Branch.update_revisions."""
 
1440
        other.lock_read()
 
1441
        try:
 
1442
            if stop_revision is None:
 
1443
                stop_revision = other.last_revision()
 
1444
                if stop_revision is None:
 
1445
                    # if there are no commits, we're done.
 
1446
                    return
 
1447
            else:
 
1448
                stop_revision = osutils.safe_revision_id(stop_revision)
 
1449
            # whats the current last revision, before we fetch [and change it
 
1450
            # possibly]
 
1451
            last_rev = self.last_revision()
 
1452
            # we fetch here regardless of whether we need to so that we pickup
 
1453
            # filled in ghosts.
 
1454
            self.fetch(other, stop_revision)
 
1455
            my_ancestry = self.repository.get_ancestry(last_rev,
 
1456
                                                       topo_sorted=False)
 
1457
            if stop_revision in my_ancestry:
 
1458
                # last_revision is a descendant of stop_revision
 
1459
                return
 
1460
            self.generate_revision_history(stop_revision, last_rev=last_rev,
 
1461
                other_branch=other)
 
1462
        finally:
 
1463
            other.unlock()
 
1464
 
2047
1465
    def basis_tree(self):
2048
1466
        """See Branch.basis_tree."""
2049
1467
        return self.repository.revision_tree(self.last_revision())
2050
1468
 
 
1469
    @deprecated_method(zero_eight)
 
1470
    def working_tree(self):
 
1471
        """Create a Working tree object for this branch."""
 
1472
 
 
1473
        from bzrlib.transport.local import LocalTransport
 
1474
        if (self.base.find('://') != -1 or 
 
1475
            not isinstance(self._transport, LocalTransport)):
 
1476
            raise NoWorkingTree(self.base)
 
1477
        return self.bzrdir.open_workingtree()
 
1478
 
2051
1479
    @needs_write_lock
2052
1480
    def pull(self, source, overwrite=False, stop_revision=None,
2053
 
             _hook_master=None, run_hooks=True, possible_transports=None,
2054
 
             _override_hook_target=None):
 
1481
             _hook_master=None, run_hooks=True):
2055
1482
        """See Branch.pull.
2056
1483
 
2057
 
        :param _hook_master: Private parameter - set the branch to
2058
 
            be supplied as the master to pull hooks.
 
1484
        :param _hook_master: Private parameter - set the branch to 
 
1485
            be supplied as the master to push hooks.
2059
1486
        :param run_hooks: Private parameter - if false, this branch
2060
1487
            is being called because it's the master of the primary branch,
2061
1488
            so it should not run its hooks.
2062
 
        :param _override_hook_target: Private parameter - set the branch to be
2063
 
            supplied as the target_branch to pull hooks.
2064
1489
        """
2065
1490
        result = PullResult()
2066
1491
        result.source_branch = source
2067
 
        if _override_hook_target is None:
2068
 
            result.target_branch = self
2069
 
        else:
2070
 
            result.target_branch = _override_hook_target
 
1492
        result.target_branch = self
2071
1493
        source.lock_read()
2072
1494
        try:
2073
 
            # We assume that during 'pull' the local repository is closer than
2074
 
            # the remote one.
2075
 
            graph = self.repository.get_graph(source.repository)
2076
1495
            result.old_revno, result.old_revid = self.last_revision_info()
2077
 
            self.update_revisions(source, stop_revision, overwrite=overwrite,
2078
 
                                  graph=graph)
2079
 
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1496
            try:
 
1497
                self.update_revisions(source, stop_revision)
 
1498
            except DivergedBranches:
 
1499
                if not overwrite:
 
1500
                    raise
 
1501
            if overwrite:
 
1502
                if stop_revision is None:
 
1503
                    stop_revision = source.last_revision()
 
1504
                self.generate_revision_history(stop_revision)
 
1505
            result.tag_conflicts = source.tags.merge_to(self.tags)
2080
1506
            result.new_revno, result.new_revid = self.last_revision_info()
2081
1507
            if _hook_master:
2082
1508
                result.master_branch = _hook_master
2083
 
                result.local_branch = result.target_branch
 
1509
                result.local_branch = self
2084
1510
            else:
2085
 
                result.master_branch = result.target_branch
 
1511
                result.master_branch = self
2086
1512
                result.local_branch = None
2087
1513
            if run_hooks:
2088
1514
                for hook in Branch.hooks['post_pull']:
2095
1521
        _locs = ['parent', 'pull', 'x-pull']
2096
1522
        for l in _locs:
2097
1523
            try:
2098
 
                return self._transport.get_bytes(l).strip('\n')
2099
 
            except errors.NoSuchFile:
 
1524
                return self.control_files.get(l).read().strip('\n')
 
1525
            except NoSuchFile:
2100
1526
                pass
2101
1527
        return None
2102
1528
 
2108
1534
        This is the basic concrete implementation of push()
2109
1535
 
2110
1536
        :param _override_hook_source_branch: If specified, run
2111
 
        the hooks passing this Branch as the source, rather than self.
 
1537
        the hooks passing this Branch as the source, rather than self.  
2112
1538
        This is for use of RemoteBranch, where push is delegated to the
2113
 
        underlying vfs-based Branch.
 
1539
        underlying vfs-based Branch. 
2114
1540
        """
2115
1541
        # TODO: Public option to disable running hooks - should be trivial but
2116
1542
        # needs tests.
2117
 
        return _run_with_write_locked_target(
2118
 
            target, self._push_with_bound_branches, target, overwrite,
2119
 
            stop_revision,
2120
 
            _override_hook_source_branch=_override_hook_source_branch)
 
1543
        target.lock_write()
 
1544
        try:
 
1545
            result = self._push_with_bound_branches(target, overwrite,
 
1546
                    stop_revision,
 
1547
                    _override_hook_source_branch=_override_hook_source_branch)
 
1548
            return result
 
1549
        finally:
 
1550
            target.unlock()
2121
1551
 
2122
1552
    def _push_with_bound_branches(self, target, overwrite,
2123
1553
            stop_revision,
2124
1554
            _override_hook_source_branch=None):
2125
1555
        """Push from self into target, and into target's master if any.
2126
 
 
2127
 
        This is on the base BzrBranch class even though it doesn't support
 
1556
        
 
1557
        This is on the base BzrBranch class even though it doesn't support 
2128
1558
        bound branches because the *target* might be bound.
2129
1559
        """
2130
1560
        def _run_hooks():
2170
1600
 
2171
1601
        Must be called with self read locked and target write locked.
2172
1602
        """
2173
 
        result = BranchPushResult()
 
1603
        result = PushResult()
2174
1604
        result.source_branch = self
2175
1605
        result.target_branch = target
2176
1606
        result.old_revno, result.old_revid = target.last_revision_info()
2177
 
        if result.old_revid != self.last_revision():
2178
 
            # We assume that during 'push' this repository is closer than
2179
 
            # the target.
2180
 
            graph = self.repository.get_graph(target.repository)
2181
 
            target.update_revisions(self, stop_revision, overwrite=overwrite,
2182
 
                                    graph=graph)
2183
 
        if self._push_should_merge_tags():
2184
 
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
1607
        try:
 
1608
            target.update_revisions(self, stop_revision)
 
1609
        except DivergedBranches:
 
1610
            if not overwrite:
 
1611
                raise
 
1612
        if overwrite:
 
1613
            target.set_revision_history(self.revision_history())
 
1614
        result.tag_conflicts = self.tags.merge_to(target.tags)
2185
1615
        result.new_revno, result.new_revid = target.last_revision_info()
2186
1616
        return result
2187
1617
 
2188
 
    def get_stacked_on_url(self):
2189
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1618
    def get_parent(self):
 
1619
        """See Branch.get_parent."""
 
1620
 
 
1621
        assert self.base[-1] == '/'
 
1622
        parent = self._get_parent_location()
 
1623
        if parent is None:
 
1624
            return parent
 
1625
        # This is an old-format absolute path to a local branch
 
1626
        # turn it into a url
 
1627
        if parent.startswith('/'):
 
1628
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1629
        try:
 
1630
            return urlutils.join(self.base[:-1], parent)
 
1631
        except errors.InvalidURLJoin, e:
 
1632
            raise errors.InaccessibleParent(parent, self.base)
2190
1633
 
2191
1634
    def set_push_location(self, location):
2192
1635
        """See Branch.set_push_location."""
2200
1643
        # TODO: Maybe delete old location files?
2201
1644
        # URLs should never be unicode, even on the local fs,
2202
1645
        # FIXUP this and get_parent in a future branch format bump:
2203
 
        # read and rewrite the file. RBC 20060125
 
1646
        # read and rewrite the file, and have the new format code read
 
1647
        # using .get not .get_utf8. RBC 20060125
2204
1648
        if url is not None:
2205
1649
            if isinstance(url, unicode):
2206
 
                try:
 
1650
                try: 
2207
1651
                    url = url.encode('ascii')
2208
1652
                except UnicodeEncodeError:
2209
1653
                    raise errors.InvalidURL(url,
2214
1658
 
2215
1659
    def _set_parent_location(self, url):
2216
1660
        if url is None:
2217
 
            self._transport.delete('parent')
 
1661
            self.control_files._transport.delete('parent')
2218
1662
        else:
2219
 
            self._transport.put_bytes('parent', url + '\n',
2220
 
                mode=self.bzrdir._get_file_mode())
 
1663
            assert isinstance(url, str)
 
1664
            self.control_files.put_bytes('parent', url + '\n')
 
1665
 
 
1666
    @deprecated_function(zero_nine)
 
1667
    def tree_config(self):
 
1668
        """DEPRECATED; call get_config instead.  
 
1669
        TreeConfig has become part of BranchConfig."""
 
1670
        return TreeConfig(self)
2221
1671
 
2222
1672
 
2223
1673
class BzrBranch5(BzrBranch):
2224
 
    """A format 5 branch. This supports new features over plain branches.
 
1674
    """A format 5 branch. This supports new features over plan branches.
2225
1675
 
2226
1676
    It has support for a master_branch which is the data for bound branches.
2227
1677
    """
2228
1678
 
 
1679
    def __init__(self,
 
1680
                 _format,
 
1681
                 _control_files,
 
1682
                 a_bzrdir,
 
1683
                 _repository):
 
1684
        super(BzrBranch5, self).__init__(_format=_format,
 
1685
                                         _control_files=_control_files,
 
1686
                                         a_bzrdir=a_bzrdir,
 
1687
                                         _repository=_repository)
 
1688
        
2229
1689
    @needs_write_lock
2230
1690
    def pull(self, source, overwrite=False, stop_revision=None,
2231
 
             run_hooks=True, possible_transports=None,
2232
 
             _override_hook_target=None):
 
1691
             run_hooks=True):
2233
1692
        """Pull from source into self, updating my master if any.
2234
 
 
 
1693
        
2235
1694
        :param run_hooks: Private parameter - if false, this branch
2236
1695
            is being called because it's the master of the primary branch,
2237
1696
            so it should not run its hooks.
2240
1699
        master_branch = None
2241
1700
        if bound_location and source.base != bound_location:
2242
1701
            # not pulling from master, so we need to update master.
2243
 
            master_branch = self.get_master_branch(possible_transports)
 
1702
            master_branch = self.get_master_branch()
2244
1703
            master_branch.lock_write()
2245
1704
        try:
2246
1705
            if master_branch:
2249
1708
                    run_hooks=False)
2250
1709
            return super(BzrBranch5, self).pull(source, overwrite,
2251
1710
                stop_revision, _hook_master=master_branch,
2252
 
                run_hooks=run_hooks,
2253
 
                _override_hook_target=_override_hook_target)
 
1711
                run_hooks=run_hooks)
2254
1712
        finally:
2255
1713
            if master_branch:
2256
1714
                master_branch.unlock()
2257
1715
 
2258
1716
    def get_bound_location(self):
2259
1717
        try:
2260
 
            return self._transport.get_bytes('bound')[:-1]
 
1718
            return self.control_files.get_utf8('bound').read()[:-1]
2261
1719
        except errors.NoSuchFile:
2262
1720
            return None
2263
1721
 
2264
1722
    @needs_read_lock
2265
 
    def get_master_branch(self, possible_transports=None):
 
1723
    def get_master_branch(self):
2266
1724
        """Return the branch we are bound to.
2267
 
 
 
1725
        
2268
1726
        :return: Either a Branch, or None
2269
1727
 
2270
1728
        This could memoise the branch, but if thats done
2276
1734
        if not bound_loc:
2277
1735
            return None
2278
1736
        try:
2279
 
            return Branch.open(bound_loc,
2280
 
                               possible_transports=possible_transports)
 
1737
            return Branch.open(bound_loc)
2281
1738
        except (errors.NotBranchError, errors.ConnectionError), e:
2282
1739
            raise errors.BoundBranchConnectionFailure(
2283
1740
                    self, bound_loc, e)
2289
1746
        :param location: URL to the target branch
2290
1747
        """
2291
1748
        if location:
2292
 
            self._transport.put_bytes('bound', location+'\n',
2293
 
                mode=self.bzrdir._get_file_mode())
 
1749
            self.control_files.put_utf8('bound', location+'\n')
2294
1750
        else:
2295
1751
            try:
2296
 
                self._transport.delete('bound')
2297
 
            except errors.NoSuchFile:
 
1752
                self.control_files._transport.delete('bound')
 
1753
            except NoSuchFile:
2298
1754
                return False
2299
1755
            return True
2300
1756
 
2306
1762
        check for divergence to raise an error when the branches are not
2307
1763
        either the same, or one a prefix of the other. That behaviour may not
2308
1764
        be useful, so that check may be removed in future.
2309
 
 
 
1765
        
2310
1766
        :param other: The branch to bind to
2311
1767
        :type other: Branch
2312
1768
        """
2322
1778
        # last_rev is not in the other_last_rev history, AND
2323
1779
        # other_last_rev is not in our history, and do it without pulling
2324
1780
        # history around
 
1781
        last_rev = self.last_revision()
 
1782
        if last_rev is not None:
 
1783
            other.lock_read()
 
1784
            try:
 
1785
                other_last_rev = other.last_revision()
 
1786
                if other_last_rev is not None:
 
1787
                    # neither branch is new, we have to do some work to
 
1788
                    # ascertain diversion.
 
1789
                    remote_graph = other.repository.get_revision_graph(
 
1790
                        other_last_rev)
 
1791
                    local_graph = self.repository.get_revision_graph(last_rev)
 
1792
                    if (last_rev not in remote_graph and
 
1793
                        other_last_rev not in local_graph):
 
1794
                        raise errors.DivergedBranches(self, other)
 
1795
            finally:
 
1796
                other.unlock()
2325
1797
        self.set_bound_location(other.base)
2326
1798
 
2327
1799
    @needs_write_lock
2330
1802
        return self.set_bound_location(None)
2331
1803
 
2332
1804
    @needs_write_lock
2333
 
    def update(self, possible_transports=None):
2334
 
        """Synchronise this branch with the master branch if any.
 
1805
    def update(self):
 
1806
        """Synchronise this branch with the master branch if any. 
2335
1807
 
2336
1808
        :return: None or the last_revision that was pivoted out during the
2337
1809
                 update.
2338
1810
        """
2339
 
        master = self.get_master_branch(possible_transports)
 
1811
        master = self.get_master_branch()
2340
1812
        if master is not None:
2341
 
            old_tip = _mod_revision.ensure_null(self.last_revision())
 
1813
            old_tip = self.last_revision()
2342
1814
            self.pull(master, overwrite=True)
2343
 
            if self.repository.get_graph().is_ancestor(old_tip,
2344
 
                _mod_revision.ensure_null(self.last_revision())):
 
1815
            if old_tip in self.repository.get_ancestry(self.last_revision(),
 
1816
                                                       topo_sorted=False):
2345
1817
                return None
2346
1818
            return old_tip
2347
1819
        return None
2348
1820
 
2349
1821
 
2350
 
class BzrBranch7(BzrBranch5):
2351
 
    """A branch with support for a fallback repository."""
2352
 
 
2353
 
    def _open_hook(self):
2354
 
        if self._ignore_fallbacks:
2355
 
            return
 
1822
class BzrBranchExperimental(BzrBranch5):
 
1823
    """Bzr experimental branch format
 
1824
 
 
1825
    This format has:
 
1826
     - a revision-history file.
 
1827
     - a format string
 
1828
     - a lock dir guarding the branch itself
 
1829
     - all of this stored in a branch/ subdirectory
 
1830
     - works with shared repositories.
 
1831
     - a tag dictionary in the branch
 
1832
 
 
1833
    This format is new in bzr 0.15, but shouldn't be used for real data, 
 
1834
    only for testing.
 
1835
 
 
1836
    This class acts as it's own BranchFormat.
 
1837
    """
 
1838
 
 
1839
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1840
 
 
1841
    @classmethod
 
1842
    def get_format_string(cls):
 
1843
        """See BranchFormat.get_format_string()."""
 
1844
        return "Bazaar-NG branch format experimental\n"
 
1845
 
 
1846
    @classmethod
 
1847
    def get_format_description(cls):
 
1848
        """See BranchFormat.get_format_description()."""
 
1849
        return "Experimental branch format"
 
1850
 
 
1851
    @classmethod
 
1852
    def get_reference(cls, a_bzrdir):
 
1853
        """Get the target reference of the branch in a_bzrdir.
 
1854
 
 
1855
        format probing must have been completed before calling
 
1856
        this method - it is assumed that the format of the branch
 
1857
        in a_bzrdir is correct.
 
1858
 
 
1859
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1860
        :return: None if the branch is not a reference branch.
 
1861
        """
 
1862
        return None
 
1863
 
 
1864
    @classmethod
 
1865
    def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
 
1866
            lock_class):
 
1867
        branch_transport = a_bzrdir.get_branch_transport(cls)
 
1868
        control_files = lockable_files.LockableFiles(branch_transport,
 
1869
            lock_filename, lock_class)
 
1870
        control_files.create_lock()
 
1871
        control_files.lock_write()
2356
1872
        try:
2357
 
            url = self.get_stacked_on_url()
2358
 
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2359
 
            errors.UnstackableBranchFormat):
2360
 
            pass
2361
 
        else:
2362
 
            for hook in Branch.hooks['transform_fallback_location']:
2363
 
                url = hook(self, url)
2364
 
                if url is None:
2365
 
                    hook_name = Branch.hooks.get_hook_name(hook)
2366
 
                    raise AssertionError(
2367
 
                        "'transform_fallback_location' hook %s returned "
2368
 
                        "None, not a URL." % hook_name)
2369
 
            self._activate_fallback_location(url)
2370
 
 
2371
 
    def __init__(self, *args, **kwargs):
2372
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2373
 
        super(BzrBranch7, self).__init__(*args, **kwargs)
2374
 
        self._last_revision_info_cache = None
2375
 
        self._partial_revision_history_cache = []
2376
 
 
2377
 
    def _clear_cached_state(self):
2378
 
        super(BzrBranch7, self)._clear_cached_state()
2379
 
        self._last_revision_info_cache = None
2380
 
        self._partial_revision_history_cache = []
2381
 
 
2382
 
    def _last_revision_info(self):
2383
 
        revision_string = self._transport.get_bytes('last-revision')
 
1873
            for filename, content in utf8_files:
 
1874
                control_files.put_utf8(filename, content)
 
1875
        finally:
 
1876
            control_files.unlock()
 
1877
        
 
1878
    @classmethod
 
1879
    def initialize(cls, a_bzrdir):
 
1880
        """Create a branch of this format in a_bzrdir."""
 
1881
        utf8_files = [('format', cls.get_format_string()),
 
1882
                      ('revision-history', ''),
 
1883
                      ('branch-name', ''),
 
1884
                      ('tags', ''),
 
1885
                      ]
 
1886
        cls._initialize_control_files(a_bzrdir, utf8_files,
 
1887
            'lock', lockdir.LockDir)
 
1888
        return cls.open(a_bzrdir, _found=True)
 
1889
 
 
1890
    @classmethod
 
1891
    def open(cls, a_bzrdir, _found=False):
 
1892
        """Return the branch object for a_bzrdir
 
1893
 
 
1894
        _found is a private parameter, do not use it. It is used to indicate
 
1895
               if format probing has already be done.
 
1896
        """
 
1897
        if not _found:
 
1898
            format = BranchFormat.find_format(a_bzrdir)
 
1899
            assert format.__class__ == cls
 
1900
        transport = a_bzrdir.get_branch_transport(None)
 
1901
        control_files = lockable_files.LockableFiles(transport, 'lock',
 
1902
                                                     lockdir.LockDir)
 
1903
        return cls(_format=cls,
 
1904
            _control_files=control_files,
 
1905
            a_bzrdir=a_bzrdir,
 
1906
            _repository=a_bzrdir.find_repository())
 
1907
 
 
1908
    @classmethod
 
1909
    def is_supported(cls):
 
1910
        return True
 
1911
 
 
1912
    def _make_tags(self):
 
1913
        return BasicTags(self)
 
1914
 
 
1915
    @classmethod
 
1916
    def supports_tags(cls):
 
1917
        return True
 
1918
 
 
1919
 
 
1920
BranchFormat.register_format(BzrBranchExperimental)
 
1921
 
 
1922
 
 
1923
class BzrBranch6(BzrBranch5):
 
1924
 
 
1925
    @needs_read_lock
 
1926
    def last_revision_info(self):
 
1927
        revision_string = self.control_files.get('last-revision').read()
2384
1928
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2385
1929
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2386
1930
        revno = int(revno)
2387
1931
        return revno, revision_id
2388
1932
 
 
1933
    def last_revision(self):
 
1934
        """Return last revision id, or None"""
 
1935
        revision_id = self.last_revision_info()[1]
 
1936
        if revision_id == _mod_revision.NULL_REVISION:
 
1937
            revision_id = None
 
1938
        return revision_id
 
1939
 
2389
1940
    def _write_last_revision_info(self, revno, revision_id):
2390
1941
        """Simply write out the revision id, with no checks.
2391
1942
 
2395
1946
        Intended to be called by set_last_revision_info and
2396
1947
        _write_revision_history.
2397
1948
        """
2398
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
1949
        if revision_id is None:
 
1950
            revision_id = 'null:'
2399
1951
        out_string = '%d %s\n' % (revno, revision_id)
2400
 
        self._transport.put_bytes('last-revision', out_string,
2401
 
            mode=self.bzrdir._get_file_mode())
 
1952
        self.control_files.put_bytes('last-revision', out_string)
2402
1953
 
2403
1954
    @needs_write_lock
2404
1955
    def set_last_revision_info(self, revno, revision_id):
2405
 
        revision_id = _mod_revision.ensure_null(revision_id)
2406
 
        old_revno, old_revid = self.last_revision_info()
 
1956
        revision_id = osutils.safe_revision_id(revision_id)
2407
1957
        if self._get_append_revisions_only():
2408
1958
            self._check_history_violation(revision_id)
2409
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2410
1959
        self._write_last_revision_info(revno, revision_id)
2411
1960
        self._clear_cached_state()
2412
 
        self._last_revision_info_cache = revno, revision_id
2413
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2414
 
 
2415
 
    def _synchronize_history(self, destination, revision_id):
2416
 
        """Synchronize last revision and revision history between branches.
2417
 
 
2418
 
        :see: Branch._synchronize_history
2419
 
        """
2420
 
        # XXX: The base Branch has a fast implementation of this method based
2421
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2422
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2423
 
        # but wants the fast implementation, so it calls
2424
 
        # Branch._synchronize_history directly.
2425
 
        Branch._synchronize_history(self, destination, revision_id)
2426
1961
 
2427
1962
    def _check_history_violation(self, revision_id):
2428
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
2429
 
        if _mod_revision.is_null(last_revision):
 
1963
        last_revision = self.last_revision()
 
1964
        if last_revision is None:
2430
1965
            return
2431
1966
        if last_revision not in self._lefthand_history(revision_id):
2432
1967
            raise errors.AppendRevisionsOnlyViolation(self.base)
2434
1969
    def _gen_revision_history(self):
2435
1970
        """Generate the revision history from last revision
2436
1971
        """
2437
 
        last_revno, last_revision = self.last_revision_info()
2438
 
        self._extend_partial_history(stop_index=last_revno-1)
2439
 
        return list(reversed(self._partial_revision_history_cache))
2440
 
 
2441
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
2442
 
        """Extend the partial history to include a given index
2443
 
 
2444
 
        If a stop_index is supplied, stop when that index has been reached.
2445
 
        If a stop_revision is supplied, stop when that revision is
2446
 
        encountered.  Otherwise, stop when the beginning of history is
2447
 
        reached.
2448
 
 
2449
 
        :param stop_index: The index which should be present.  When it is
2450
 
            present, history extension will stop.
2451
 
        :param revision_id: The revision id which should be present.  When
2452
 
            it is encountered, history extension will stop.
2453
 
        """
2454
 
        repo = self.repository
2455
 
        if len(self._partial_revision_history_cache) == 0:
2456
 
            iterator = repo.iter_reverse_revision_history(self.last_revision())
2457
 
        else:
2458
 
            start_revision = self._partial_revision_history_cache[-1]
2459
 
            iterator = repo.iter_reverse_revision_history(start_revision)
2460
 
            #skip the last revision in the list
2461
 
            next_revision = iterator.next()
2462
 
        for revision_id in iterator:
2463
 
            self._partial_revision_history_cache.append(revision_id)
2464
 
            if (stop_index is not None and
2465
 
                len(self._partial_revision_history_cache) > stop_index):
2466
 
                break
2467
 
            if revision_id == stop_revision:
2468
 
                break
 
1972
        history = list(self.repository.iter_reverse_revision_history(
 
1973
            self.last_revision()))
 
1974
        history.reverse()
 
1975
        return history
2469
1976
 
2470
1977
    def _write_revision_history(self, history):
2471
1978
        """Factored out of set_revision_history.
2484
1991
        self._write_last_revision_info(len(history), last_revision)
2485
1992
 
2486
1993
    @needs_write_lock
 
1994
    def append_revision(self, *revision_ids):
 
1995
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
1996
        if len(revision_ids) == 0:
 
1997
            return
 
1998
        prev_revno, prev_revision = self.last_revision_info()
 
1999
        for revision in self.repository.get_revisions(revision_ids):
 
2000
            if prev_revision == _mod_revision.NULL_REVISION:
 
2001
                if revision.parent_ids != []:
 
2002
                    raise errors.NotLeftParentDescendant(self, prev_revision,
 
2003
                                                         revision.revision_id)
 
2004
            else:
 
2005
                if revision.parent_ids[0] != prev_revision:
 
2006
                    raise errors.NotLeftParentDescendant(self, prev_revision,
 
2007
                                                         revision.revision_id)
 
2008
            prev_revision = revision.revision_id
 
2009
        self.set_last_revision_info(prev_revno + len(revision_ids),
 
2010
                                    revision_ids[-1])
 
2011
 
 
2012
    @needs_write_lock
2487
2013
    def _set_parent_location(self, url):
2488
2014
        """Set the parent branch"""
2489
2015
        self._set_config_location('parent_location', url, make_relative=True)
2505
2031
            if config.get_user_option('bound') != 'True':
2506
2032
                return False
2507
2033
            else:
2508
 
                config.set_user_option('bound', 'False', warn_masked=True)
 
2034
                config.set_user_option('bound', 'False')
2509
2035
                return True
2510
2036
        else:
2511
2037
            self._set_config_location('bound_location', location,
2512
2038
                                      config=config)
2513
 
            config.set_user_option('bound', 'True', warn_masked=True)
 
2039
            config.set_user_option('bound', 'True')
2514
2040
        return True
2515
2041
 
2516
2042
    def _get_bound_location(self, bound):
2531
2057
        """See Branch.get_old_bound_location"""
2532
2058
        return self._get_bound_location(False)
2533
2059
 
2534
 
    def get_stacked_on_url(self):
2535
 
        # you can always ask for the URL; but you might not be able to use it
2536
 
        # if the repo can't support stacking.
2537
 
        ## self._check_stackable_repo()
2538
 
        stacked_url = self._get_config_location('stacked_on_location')
2539
 
        if stacked_url is None:
2540
 
            raise errors.NotStacked(self)
2541
 
        return stacked_url
2542
 
 
2543
2060
    def set_append_revisions_only(self, enabled):
2544
2061
        if enabled:
2545
2062
            value = 'True'
2546
2063
        else:
2547
2064
            value = 'False'
2548
 
        self.get_config().set_user_option('append_revisions_only', value,
2549
 
            warn_masked=True)
 
2065
        self.get_config().set_user_option('append_revisions_only', value)
2550
2066
 
2551
2067
    def _get_append_revisions_only(self):
2552
2068
        value = self.get_config().get_user_option('append_revisions_only')
2553
2069
        return value == 'True'
2554
2070
 
2555
 
    @needs_write_lock
2556
 
    def generate_revision_history(self, revision_id, last_rev=None,
2557
 
                                  other_branch=None):
2558
 
        """See BzrBranch5.generate_revision_history"""
2559
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2560
 
        revno = len(history)
2561
 
        self.set_last_revision_info(revno, revision_id)
2562
 
 
2563
 
    @needs_read_lock
2564
 
    def get_rev_id(self, revno, history=None):
2565
 
        """Find the revision id of the specified revno."""
2566
 
        if revno == 0:
2567
 
            return _mod_revision.NULL_REVISION
2568
 
 
2569
 
        last_revno, last_revision_id = self.last_revision_info()
2570
 
        if revno <= 0 or revno > last_revno:
2571
 
            raise errors.NoSuchRevision(self, revno)
2572
 
 
2573
 
        if history is not None:
2574
 
            return history[revno - 1]
2575
 
 
2576
 
        index = last_revno - revno
2577
 
        if len(self._partial_revision_history_cache) <= index:
2578
 
            self._extend_partial_history(stop_index=index)
2579
 
        if len(self._partial_revision_history_cache) > index:
2580
 
            return self._partial_revision_history_cache[index]
 
2071
    def _synchronize_history(self, destination, revision_id):
 
2072
        """Synchronize last revision and revision history between branches.
 
2073
 
 
2074
        This version is most efficient when the destination is also a
 
2075
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
2076
        repository contains all the lefthand ancestors of the intended
 
2077
        last_revision.  If not, set_last_revision_info will fail.
 
2078
 
 
2079
        :param destination: The branch to copy the history into
 
2080
        :param revision_id: The revision-id to truncate history at.  May
 
2081
          be None to copy complete history.
 
2082
        """
 
2083
        if revision_id is None:
 
2084
            revno, revision_id = self.last_revision_info()
2581
2085
        else:
2582
 
            raise errors.NoSuchRevision(self, revno)
2583
 
 
2584
 
    @needs_read_lock
2585
 
    def revision_id_to_revno(self, revision_id):
2586
 
        """Given a revision id, return its revno"""
2587
 
        if _mod_revision.is_null(revision_id):
2588
 
            return 0
2589
 
        try:
2590
 
            index = self._partial_revision_history_cache.index(revision_id)
2591
 
        except ValueError:
2592
 
            self._extend_partial_history(stop_revision=revision_id)
2593
 
            index = len(self._partial_revision_history_cache) - 1
2594
 
            if self._partial_revision_history_cache[index] != revision_id:
2595
 
                raise errors.NoSuchRevision(self, revision_id)
2596
 
        return self.revno() - index
2597
 
 
2598
 
 
2599
 
class BzrBranch6(BzrBranch7):
2600
 
    """See BzrBranchFormat6 for the capabilities of this branch.
2601
 
 
2602
 
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2603
 
    i.e. stacking.
2604
 
    """
2605
 
 
2606
 
    def get_stacked_on_url(self):
2607
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2086
            # To figure out the revno for a random revision, we need to build
 
2087
            # the revision history, and count its length.
 
2088
            # We don't care about the order, just how long it is.
 
2089
            # Alternatively, we could start at the current location, and count
 
2090
            # backwards. But there is no guarantee that we will find it since
 
2091
            # it may be a merged revision.
 
2092
            revno = len(list(self.repository.iter_reverse_revision_history(
 
2093
                                                                revision_id)))
 
2094
        destination.set_last_revision_info(revno, revision_id)
 
2095
 
 
2096
    def _make_tags(self):
 
2097
        return BasicTags(self)
2608
2098
 
2609
2099
 
2610
2100
######################################################################
2628
2118
    :ivar new_revno: Revision number after pull.
2629
2119
    :ivar old_revid: Tip revision id before pull.
2630
2120
    :ivar new_revid: Tip revision id after pull.
2631
 
    :ivar source_branch: Source (local) branch object. (read locked)
2632
 
    :ivar master_branch: Master branch of the target, or the target if no
2633
 
        Master
2634
 
    :ivar local_branch: target branch if there is a Master, else None
2635
 
    :ivar target_branch: Target/destination branch object. (write locked)
2636
 
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
2121
    :ivar source_branch: Source (local) branch object.
 
2122
    :ivar master_branch: Master branch of the target, or None.
 
2123
    :ivar target_branch: Target/destination branch object.
2637
2124
    """
2638
2125
 
2639
2126
    def __int__(self):
2641
2128
        return self.new_revno - self.old_revno
2642
2129
 
2643
2130
    def report(self, to_file):
2644
 
        if not is_quiet():
2645
 
            if self.old_revid == self.new_revid:
2646
 
                to_file.write('No revisions to pull.\n')
2647
 
            else:
2648
 
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
2131
        if self.old_revid == self.new_revid:
 
2132
            to_file.write('No revisions to pull.\n')
 
2133
        else:
 
2134
            to_file.write('Now on revision %d.\n' % self.new_revno)
2649
2135
        self._show_tag_conficts(to_file)
2650
2136
 
2651
2137
 
2652
 
class BranchPushResult(_Result):
 
2138
class PushResult(_Result):
2653
2139
    """Result of a Branch.push operation.
2654
2140
 
2655
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
2656
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
2657
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2658
 
        before the push.
2659
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2660
 
        after the push.
2661
 
    :ivar source_branch: Source branch object that the push was from. This is
2662
 
        read locked, and generally is a local (and thus low latency) branch.
2663
 
    :ivar master_branch: If target is a bound branch, the master branch of
2664
 
        target, or target itself. Always write locked.
2665
 
    :ivar target_branch: The direct Branch where data is being sent (write
2666
 
        locked).
2667
 
    :ivar local_branch: If the target is a bound branch this will be the
2668
 
        target, otherwise it will be None.
 
2141
    :ivar old_revno: Revision number before push.
 
2142
    :ivar new_revno: Revision number after push.
 
2143
    :ivar old_revid: Tip revision id before push.
 
2144
    :ivar new_revid: Tip revision id after push.
 
2145
    :ivar source_branch: Source branch object.
 
2146
    :ivar master_branch: Master branch of the target, or None.
 
2147
    :ivar target_branch: Target/destination branch object.
2669
2148
    """
2670
2149
 
2671
2150
    def __int__(self):
2675
2154
    def report(self, to_file):
2676
2155
        """Write a human-readable description of the result."""
2677
2156
        if self.old_revid == self.new_revid:
2678
 
            note('No new revisions to push.')
 
2157
            to_file.write('No new revisions to push.\n')
2679
2158
        else:
2680
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2159
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2681
2160
        self._show_tag_conficts(to_file)
2682
2161
 
2683
2162
 
2692
2171
 
2693
2172
    def report_results(self, verbose):
2694
2173
        """Report the check results via trace.note.
2695
 
 
 
2174
        
2696
2175
        :param verbose: Requests more detailed display of what was checked,
2697
2176
            if any.
2698
2177
        """
2710
2189
        new_branch = format.open(branch.bzrdir, _found=True)
2711
2190
 
2712
2191
        # Copy source data into target
2713
 
        new_branch._write_last_revision_info(*branch.last_revision_info())
 
2192
        new_branch.set_last_revision_info(*branch.last_revision_info())
2714
2193
        new_branch.set_parent(branch.get_parent())
2715
2194
        new_branch.set_bound_location(branch.get_bound_location())
2716
2195
        new_branch.set_push_location(branch.get_push_location())
2719
2198
        new_branch.tags._set_tag_dict({})
2720
2199
 
2721
2200
        # Copying done; now update target format
2722
 
        new_branch._transport.put_bytes('format',
2723
 
            format.get_format_string(),
2724
 
            mode=new_branch.bzrdir._get_file_mode())
 
2201
        new_branch.control_files.put_utf8('format',
 
2202
            format.get_format_string())
2725
2203
 
2726
2204
        # Clean up old files
2727
 
        new_branch._transport.delete('revision-history')
 
2205
        new_branch.control_files._transport.delete('revision-history')
2728
2206
        try:
2729
2207
            branch.set_parent(None)
2730
 
        except errors.NoSuchFile:
 
2208
        except NoSuchFile:
2731
2209
            pass
2732
2210
        branch.set_bound_location(None)
2733
 
 
2734
 
 
2735
 
class Converter6to7(object):
2736
 
    """Perform an in-place upgrade of format 6 to format 7"""
2737
 
 
2738
 
    def convert(self, branch):
2739
 
        format = BzrBranchFormat7()
2740
 
        branch._set_config_location('stacked_on_location', '')
2741
 
        # update target format
2742
 
        branch._transport.put_bytes('format', format.get_format_string())
2743
 
 
2744
 
 
2745
 
 
2746
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2747
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2748
 
    duration.
2749
 
 
2750
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
2751
 
 
2752
 
    If an exception is raised by callable, then that exception *will* be
2753
 
    propagated, even if the unlock attempt raises its own error.  Thus
2754
 
    _run_with_write_locked_target should be preferred to simply doing::
2755
 
 
2756
 
        target.lock_write()
2757
 
        try:
2758
 
            return callable(*args, **kwargs)
2759
 
        finally:
2760
 
            target.unlock()
2761
 
 
2762
 
    """
2763
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
2764
 
    # should share code?
2765
 
    target.lock_write()
2766
 
    try:
2767
 
        result = callable(*args, **kwargs)
2768
 
    except:
2769
 
        exc_info = sys.exc_info()
2770
 
        try:
2771
 
            target.unlock()
2772
 
        finally:
2773
 
            raise exc_info[0], exc_info[1], exc_info[2]
2774
 
    else:
2775
 
        target.unlock()
2776
 
        return result
2777
 
 
2778
 
 
2779
 
class InterBranch(InterObject):
2780
 
    """This class represents operations taking place between two branches.
2781
 
 
2782
 
    Its instances have methods like pull() and push() and contain
2783
 
    references to the source and target repositories these operations
2784
 
    can be carried out on.
2785
 
    """
2786
 
 
2787
 
    _optimisers = []
2788
 
    """The available optimised InterBranch types."""
2789
 
 
2790
 
    @staticmethod
2791
 
    def _get_branch_formats_to_test():
2792
 
        """Return a tuple with the Branch formats to use when testing."""
2793
 
        raise NotImplementedError(self._get_branch_formats_to_test)
2794
 
 
2795
 
    def update_revisions(self, stop_revision=None, overwrite=False,
2796
 
                         graph=None):
2797
 
        """Pull in new perfect-fit revisions.
2798
 
 
2799
 
        :param stop_revision: Updated until the given revision
2800
 
        :param overwrite: Always set the branch pointer, rather than checking
2801
 
            to see if it is a proper descendant.
2802
 
        :param graph: A Graph object that can be used to query history
2803
 
            information. This can be None.
2804
 
        :return: None
2805
 
        """
2806
 
        raise NotImplementedError(self.update_revisions)
2807
 
 
2808
 
 
2809
 
class GenericInterBranch(InterBranch):
2810
 
    """InterBranch implementation that uses public Branch functions.
2811
 
    """
2812
 
 
2813
 
    @staticmethod
2814
 
    def _get_branch_formats_to_test():
2815
 
        return BranchFormat._default_format, BranchFormat._default_format
2816
 
 
2817
 
    def update_revisions(self, stop_revision=None, overwrite=False,
2818
 
        graph=None):
2819
 
        """See InterBranch.update_revisions()."""
2820
 
        self.source.lock_read()
2821
 
        try:
2822
 
            other_revno, other_last_revision = self.source.last_revision_info()
2823
 
            stop_revno = None # unknown
2824
 
            if stop_revision is None:
2825
 
                stop_revision = other_last_revision
2826
 
                if _mod_revision.is_null(stop_revision):
2827
 
                    # if there are no commits, we're done.
2828
 
                    return
2829
 
                stop_revno = other_revno
2830
 
 
2831
 
            # what's the current last revision, before we fetch [and change it
2832
 
            # possibly]
2833
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
2834
 
            # we fetch here so that we don't process data twice in the common
2835
 
            # case of having something to pull, and so that the check for
2836
 
            # already merged can operate on the just fetched graph, which will
2837
 
            # be cached in memory.
2838
 
            self.target.fetch(self.source, stop_revision)
2839
 
            # Check to see if one is an ancestor of the other
2840
 
            if not overwrite:
2841
 
                if graph is None:
2842
 
                    graph = self.target.repository.get_graph()
2843
 
                if self.target._check_if_descendant_or_diverged(
2844
 
                        stop_revision, last_rev, graph, self.source):
2845
 
                    # stop_revision is a descendant of last_rev, but we aren't
2846
 
                    # overwriting, so we're done.
2847
 
                    return
2848
 
            if stop_revno is None:
2849
 
                if graph is None:
2850
 
                    graph = self.target.repository.get_graph()
2851
 
                this_revno, this_last_revision = \
2852
 
                        self.target.last_revision_info()
2853
 
                stop_revno = graph.find_distance_to_null(stop_revision,
2854
 
                                [(other_last_revision, other_revno),
2855
 
                                 (this_last_revision, this_revno)])
2856
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
2857
 
        finally:
2858
 
            self.source.unlock()
2859
 
 
2860
 
    @classmethod
2861
 
    def is_compatible(self, source, target):
2862
 
        # GenericBranch uses the public API, so always compatible
2863
 
        return True
2864
 
 
2865
 
 
2866
 
InterBranch.register_optimiser(GenericInterBranch)