~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Ian Clatworthy
  • Date: 2008-04-01 04:19:06 UTC
  • mfrom: (3302.6.1 xma-mailmode)
  • mto: This revision was merged to the branch mainline in revision 3323.
  • Revision ID: ian.clatworthy@canonical.com-20080401041906-s7ekpfpo0tnyfkbz
Add mail-mode GNU Emacs mail package as a mail client option (Xavier Maillard)

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
 
19
17
 
20
18
from bzrlib.lazy_import import lazy_import
21
19
lazy_import(globals(), """
22
 
from itertools import chain
23
20
from bzrlib import (
24
21
        bzrdir,
25
22
        cache_utf8,
30
27
        lockable_files,
31
28
        repository,
32
29
        revision as _mod_revision,
33
 
        symbol_versioning,
34
30
        transport,
35
31
        tsort,
36
32
        ui,
37
33
        urlutils,
38
34
        )
39
 
from bzrlib.config import BranchConfig, TransportConfig
40
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
35
from bzrlib.config import BranchConfig
41
36
from bzrlib.tag import (
42
37
    BasicTags,
43
38
    DisabledTags,
45
40
""")
46
41
 
47
42
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
 
    )
 
43
from bzrlib.hooks import Hooks
 
44
from bzrlib.symbol_versioning import (deprecated_method,
 
45
                                      zero_sixteen,
 
46
                                      )
55
47
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
56
48
 
57
49
 
84
76
    # - RBC 20060112
85
77
    base = None
86
78
 
 
79
    # override this to set the strategy for storing tags
 
80
    def _make_tags(self):
 
81
        return DisabledTags(self)
 
82
 
87
83
    def __init__(self, *ignored, **ignored_too):
88
 
        self.tags = self._format.make_tags(self)
 
84
        self.tags = self._make_tags()
89
85
        self._revision_history_cache = None
90
86
        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
87
 
107
88
    def break_lock(self):
108
89
        """Break a lock if one is present from another instance.
118
99
        if master is not None:
119
100
            master.break_lock()
120
101
 
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
102
    @staticmethod
127
103
    def open(base, _unsupported=False, possible_transports=None):
128
104
        """Open the branch rooted at base.
143
119
    @staticmethod
144
120
    def open_containing(url, possible_transports=None):
145
121
        """Open an existing branch which contains url.
146
 
 
 
122
        
147
123
        This probes for a branch at url, and searches upwards from there.
148
124
 
149
125
        Basically we keep looking up until we find the control directory or
150
126
        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
 
127
        If there is one and it is either an unrecognised format or an unsupported 
152
128
        format, UnknownFormatError or UnsupportedFormatError are raised.
153
129
        If there is one, it is returned, along with the unused portion of url.
154
130
        """
156
132
                                                         possible_transports)
157
133
        return control.open_branch(), relpath
158
134
 
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()
166
 
 
167
135
    def get_config(self):
168
136
        return BranchConfig(self)
169
137
 
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()
 
138
    def _get_nick(self):
 
139
        return self.get_config().get_nickname()
218
140
 
219
141
    def _set_nick(self, nick):
220
142
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
224
146
    def is_locked(self):
225
147
        raise NotImplementedError(self.is_locked)
226
148
 
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
149
    def lock_write(self):
255
150
        raise NotImplementedError(self.lock_write)
256
151
 
268
163
        raise NotImplementedError(self.get_physical_lock_status)
269
164
 
270
165
    @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
166
    def get_revision_id_to_revno_map(self):
336
167
        """Return the revision_id => dotted revno map.
337
168
 
361
192
 
362
193
        :return: A dictionary mapping revision_id => dotted revno.
363
194
        """
 
195
        last_revision = self.last_revision()
 
196
        revision_graph = repository._old_get_graph(self.repository,
 
197
            last_revision)
 
198
        merge_sorted_revisions = tsort.merge_sort(
 
199
            revision_graph,
 
200
            last_revision,
 
201
            None,
 
202
            generate_revno=True)
364
203
        revision_id_to_revno = dict((rev_id, revno)
365
 
            for rev_id, depth, revno, end_of_merge
366
 
             in self.iter_merge_sorted_revisions())
 
204
                                    for seq_num, rev_id, depth, revno, end_of_merge
 
205
                                     in merge_sorted_revisions)
367
206
        return revision_id_to_revno
368
207
 
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
208
    def leave_lock_in_place(self):
476
209
        """Tell this branch object not to release the physical lock when this
477
210
        object is unlocked.
478
 
 
 
211
        
479
212
        If lock_write doesn't return a token, then this method is not supported.
480
213
        """
481
214
        self.control_files.leave_in_place()
488
221
        """
489
222
        self.control_files.dont_leave_in_place()
490
223
 
 
224
    def abspath(self, name):
 
225
        """Return absolute filename for something in the branch
 
226
        
 
227
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
228
        method and not a tree method.
 
229
        """
 
230
        raise NotImplementedError(self.abspath)
 
231
 
491
232
    def bind(self, other):
492
233
        """Bind the local branch the other branch.
493
234
 
504
245
        :param last_revision: What revision to stop at (None for at the end
505
246
                              of the branch.
506
247
        :param pb: An optional progress bar to use.
507
 
        :return: None
 
248
 
 
249
        Returns the copied revision count and the failed revisions in a tuple:
 
250
        (copied, failures).
508
251
        """
509
252
        if self.base == from_branch.base:
510
253
            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()")
 
254
        if pb is None:
 
255
            nested_pb = ui.ui_factory.nested_progress_bar()
 
256
            pb = nested_pb
 
257
        else:
 
258
            nested_pb = None
 
259
 
515
260
        from_branch.lock_read()
516
261
        try:
517
262
            if last_revision is None:
 
263
                pb.update('get source history')
518
264
                last_revision = from_branch.last_revision()
519
265
                last_revision = _mod_revision.ensure_null(last_revision)
520
266
            return self.repository.fetch(from_branch.repository,
521
267
                                         revision_id=last_revision,
522
 
                                         pb=pb)
 
268
                                         pb=nested_pb)
523
269
        finally:
 
270
            if nested_pb is not None:
 
271
                nested_pb.finished()
524
272
            from_branch.unlock()
525
273
 
526
274
    def get_bound_location(self):
530
278
        branch.
531
279
        """
532
280
        return None
533
 
 
 
281
    
534
282
    def get_old_bound_location(self):
535
283
        """Return the URL of the branch we used to be bound to
536
284
        """
537
285
        raise errors.UpgradeRequired(self.base)
538
286
 
539
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
540
 
                           timezone=None, committer=None, revprops=None,
 
287
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
288
                           timezone=None, committer=None, revprops=None, 
541
289
                           revision_id=None):
542
290
        """Obtain a CommitBuilder for this branch.
543
 
 
 
291
        
544
292
        :param parents: Revision ids of the parents of the new revision.
545
293
        :param config: Optional configuration to use.
546
294
        :param timestamp: Optional timestamp recorded for commit.
552
300
 
553
301
        if config is None:
554
302
            config = self.get_config()
555
 
 
 
303
        
556
304
        return self.repository.get_commit_builder(self, parents, config,
557
305
            timestamp, timezone, committer, revprops, revision_id)
558
306
 
559
307
    def get_master_branch(self, possible_transports=None):
560
308
        """Return the branch we are bound to.
561
 
 
 
309
        
562
310
        :return: Either a Branch, or None
563
311
        """
564
312
        return None
569
317
        The delta is relative to its mainline predecessor, or the
570
318
        empty tree for revision 1.
571
319
        """
 
320
        assert isinstance(revno, int)
572
321
        rh = self.revision_history()
573
322
        if not (1 <= revno <= len(rh)):
574
323
            raise errors.InvalidRevisionNumber(revno)
575
324
        return self.repository.get_revision_delta(rh[revno-1])
576
325
 
577
 
    def get_stacked_on_url(self):
578
 
        """Get the URL this branch is stacked against.
 
326
    @deprecated_method(zero_sixteen)
 
327
    def get_root_id(self):
 
328
        """Return the id of this branches root
579
329
 
580
 
        :raises NotStacked: If the branch is not stacked.
581
 
        :raises UnstackableBranchFormat: If the branch does not support
582
 
            stacking.
 
330
        Deprecated: branches don't have root ids-- trees do.
 
331
        Use basis_tree().get_root_id() instead.
583
332
        """
584
 
        raise NotImplementedError(self.get_stacked_on_url)
 
333
        raise NotImplementedError(self.get_root_id)
585
334
 
586
335
    def print_file(self, file, revision_id):
587
336
        """Print `file` to stdout."""
590
339
    def set_revision_history(self, rev_history):
591
340
        raise NotImplementedError(self.set_revision_history)
592
341
 
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
342
    def _cache_revision_history(self, rev_history):
638
343
        """Set the cached revision history to rev_history.
639
344
 
664
369
        """
665
370
        self._revision_history_cache = None
666
371
        self._revision_id_to_revno_cache = None
667
 
        self._last_revision_info_cache = None
668
 
        self._merge_sorted_revisions_cache = None
669
372
 
670
373
    def _gen_revision_history(self):
671
374
        """Return sequence of revision hashes on to this branch.
672
 
 
 
375
        
673
376
        Unlike revision_history, this method always regenerates or rereads the
674
377
        revision history, i.e. it does not cache the result, so repeated calls
675
378
        may be expensive.
676
379
 
677
380
        Concrete subclasses should override this instead of revision_history so
678
381
        that subclasses do not need to deal with caching logic.
679
 
 
 
382
        
680
383
        This API is semi-public; it only for use by subclasses, all other code
681
384
        should consider it to be private.
682
385
        """
685
388
    @needs_read_lock
686
389
    def revision_history(self):
687
390
        """Return sequence of revision ids on this branch.
688
 
 
 
391
        
689
392
        This method will cache the revision history for as long as it is safe to
690
393
        do so.
691
394
        """
718
421
        """Return last revision id, or NULL_REVISION."""
719
422
        return self.last_revision_info()[1]
720
423
 
721
 
    @needs_read_lock
722
424
    def last_revision_info(self):
723
425
        """Return information about the last revision.
724
426
 
725
 
        :return: A tuple (revno, revision_id).
 
427
        :return: A tuple (revno, last_revision_id).
726
428
        """
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
429
        rh = self.revision_history()
733
430
        revno = len(rh)
734
431
        if revno:
736
433
        else:
737
434
            return (0, _mod_revision.NULL_REVISION)
738
435
 
739
 
    @deprecated_method(deprecated_in((1, 6, 0)))
740
436
    def missing_revisions(self, other, stop_revision=None):
741
437
        """Return a list of new revisions that would perfectly fit.
742
 
 
 
438
        
743
439
        If self and other have not diverged, return a list of the revisions
744
440
        present in other, but missing from self.
745
441
        """
755
451
        if stop_revision is None:
756
452
            stop_revision = other_len
757
453
        else:
 
454
            assert isinstance(stop_revision, int)
758
455
            if stop_revision > other_len:
759
456
                raise errors.NoSuchRevision(self, stop_revision)
760
457
        return other_history[self_len:stop_revision]
761
458
 
762
 
    @needs_write_lock
763
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
764
 
                         graph=None):
 
459
    def update_revisions(self, other, stop_revision=None):
765
460
        """Pull in new perfect-fit revisions.
766
461
 
767
462
        :param other: Another Branch to pull from
768
463
        :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
464
        :return: None
774
465
        """
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)
 
466
        raise NotImplementedError(self.update_revisions)
791
467
 
792
468
    def revision_id_to_revno(self, revision_id):
793
469
        """Given a revision id, return its revno"""
810
486
        return history[revno - 1]
811
487
 
812
488
    def pull(self, source, overwrite=False, stop_revision=None,
813
 
             possible_transports=None, _override_hook_target=None):
 
489
             possible_transports=None):
814
490
        """Mirror source into this branch.
815
491
 
816
492
        This branch is considered to be 'local', having low latency.
830
506
        """Return `Tree` object for last revision."""
831
507
        return self.repository.revision_tree(self.last_revision())
832
508
 
 
509
    def rename_one(self, from_rel, to_rel):
 
510
        """Rename one file.
 
511
 
 
512
        This can change the directory or the filename or both.
 
513
        """
 
514
        raise NotImplementedError(self.rename_one)
 
515
 
 
516
    def move(self, from_paths, to_name):
 
517
        """Rename files.
 
518
 
 
519
        to_name must exist as a versioned directory.
 
520
 
 
521
        If to_name exists and is a directory, the files are moved into
 
522
        it, keeping their old names.  If it is a directory, 
 
523
 
 
524
        Note that to_name is only the last component of the new name;
 
525
        this doesn't change the directory.
 
526
 
 
527
        This returns a list of (from_path, to_path) pairs for each
 
528
        entry that is moved.
 
529
        """
 
530
        raise NotImplementedError(self.move)
 
531
 
833
532
    def get_parent(self):
834
533
        """Return the parent location of the branch.
835
534
 
836
 
        This is the default location for pull/missing.  The usual
 
535
        This is the default location for push/pull/missing.  The usual
837
536
        pattern is that the user can override it by specifying a
838
537
        location.
839
538
        """
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)
 
539
        raise NotImplementedError(self.get_parent)
854
540
 
855
541
    def _set_config_location(self, name, url, config=None,
856
542
                             make_relative=False):
892
578
    def get_public_branch(self):
893
579
        """Return the public location of the branch.
894
580
 
895
 
        This is used by merge directives.
 
581
        This is is used by merge directives.
896
582
        """
897
583
        return self._get_config_location('public_branch')
898
584
 
914
600
        """Set a new push location for this branch."""
915
601
        raise NotImplementedError(self.set_push_location)
916
602
 
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
603
    def set_parent(self, url):
948
604
        raise NotImplementedError(self.set_parent)
949
605
 
950
606
    @needs_write_lock
951
607
    def update(self):
952
 
        """Synchronise this branch with the master branch if any.
 
608
        """Synchronise this branch with the master branch if any. 
953
609
 
954
610
        :return: None or the last_revision pivoted out during the update.
955
611
        """
962
618
        """
963
619
        if revno != 0:
964
620
            self.check_real_revno(revno)
965
 
 
 
621
            
966
622
    def check_real_revno(self, revno):
967
623
        """\
968
624
        Check whether a revno corresponds to a real revision.
972
628
            raise errors.InvalidRevisionNumber(revno)
973
629
 
974
630
    @needs_read_lock
975
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
631
    def clone(self, to_bzrdir, revision_id=None):
976
632
        """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
 
 
 
633
        
981
634
        revision_id: if not None, the revision history in the new branch will
982
635
                     be truncated to end with revision_id.
983
636
        """
984
 
        result = to_bzrdir.create_branch()
985
 
        if repository_policy is not None:
986
 
            repository_policy.configure_branch(result)
 
637
        result = self._format.initialize(to_bzrdir)
987
638
        self.copy_content_into(result, revision_id=revision_id)
988
639
        return  result
989
640
 
990
641
    @needs_read_lock
991
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
642
    def sprout(self, to_bzrdir, revision_id=None):
992
643
        """Create a new line of development from the branch, into to_bzrdir.
993
 
 
994
 
        to_bzrdir controls the branch format.
995
 
 
 
644
        
996
645
        revision_id: if not None, the revision history in the new branch will
997
646
                     be truncated to end with revision_id.
998
647
        """
999
 
        result = to_bzrdir.create_branch()
1000
 
        if repository_policy is not None:
1001
 
            repository_policy.configure_branch(result)
 
648
        result = self._format.initialize(to_bzrdir)
1002
649
        self.copy_content_into(result, revision_id=revision_id)
1003
650
        result.set_parent(self.bzrdir.root_transport.base)
1004
651
        return result
1007
654
        """Synchronize last revision and revision history between branches.
1008
655
 
1009
656
        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.
 
657
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
658
        history is the true lefthand parent history, and all of the revisions
 
659
        are in the destination's repository.  If not, set_revision_history
 
660
        will fail.
1013
661
 
1014
662
        :param destination: The branch to copy the history into
1015
663
        :param revision_id: The revision-id to truncate history at.  May
1016
664
          be None to copy complete history.
1017
665
        """
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)
 
666
        if revision_id == _mod_revision.NULL_REVISION:
 
667
            new_history = []
 
668
        new_history = self.revision_history()
 
669
        if revision_id is not None and new_history != []:
 
670
            try:
 
671
                new_history = new_history[:new_history.index(revision_id) + 1]
 
672
            except ValueError:
 
673
                rev = self.repository.get_revision(revision_id)
 
674
                new_history = rev.get_history(self.repository)[1:]
 
675
        destination.set_revision_history(new_history)
1034
676
 
1035
677
    @needs_read_lock
1036
678
    def copy_content_into(self, destination, revision_id=None):
1047
689
        else:
1048
690
            if parent:
1049
691
                destination.set_parent(parent)
1050
 
        if self._push_should_merge_tags():
1051
 
            self.tags.merge_to(destination.tags)
 
692
        self.tags.merge_to(destination.tags)
1052
693
 
1053
694
    @needs_read_lock
1054
695
    def check(self):
1055
696
        """Check consistency of the branch.
1056
697
 
1057
698
        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
 
699
        do actually match up in the revision graph, and that they're all 
1059
700
        present in the repository.
1060
 
 
 
701
        
1061
702
        Callers will typically also want to check the repository.
1062
703
 
1063
704
        :return: A BranchCheckResult.
1064
705
        """
1065
706
        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:
 
707
        for revision_id in self.revision_history():
1076
708
            try:
1077
709
                revision = self.repository.get_revision(revision_id)
1078
710
            except errors.NoSuchRevision, e:
1102
734
            format.set_branch_format(self._format)
1103
735
        return format
1104
736
 
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
737
    def create_checkout(self, to_location, revision_id=None,
1121
738
                        lightweight=False, accelerator_tree=None,
1122
739
                        hardlink=False):
1123
740
        """Create a checkout of a branch.
1124
 
 
 
741
        
1125
742
        :param to_location: The url to produce the checkout at
1126
743
        :param revision_id: The revision to check out
1127
744
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1146
763
                to_location, force_new_tree=False, format=format)
1147
764
            checkout = checkout_branch.bzrdir
1148
765
            checkout_branch.bind(self)
1149
 
            # pull up to the specified revision_id to set the initial
 
766
            # pull up to the specified revision_id to set the initial 
1150
767
            # branch tip correctly, and seed it with history.
1151
768
            checkout_branch.pull(self, stop_revision=revision_id)
1152
769
            from_branch=None
1166
783
            basis_tree.unlock()
1167
784
        return tree
1168
785
 
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
786
    def reference_parent(self, file_id, path):
1178
787
        """Return the parent branch for a tree-reference file_id
1179
788
        :param file_id: The file_id of the tree reference
1186
795
    def supports_tags(self):
1187
796
        return self._format.supports_tags()
1188
797
 
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
798
 
1225
799
class BranchFormat(object):
1226
800
    """An encapsulation of the initialization and open routines for a format.
1230
804
     * a format string,
1231
805
     * an open routine.
1232
806
 
1233
 
    Formats are placed in an dict by their format string for reference
 
807
    Formats are placed in an dict by their format string for reference 
1234
808
    during branch opening. Its not required that these be instances, they
1235
 
    can be classes themselves with class methods - it simply depends on
 
809
    can be classes themselves with class methods - it simply depends on 
1236
810
    whether state is needed for a given format or not.
1237
811
 
1238
812
    Once a format is deprecated, just deprecate the initialize and open
1239
 
    methods on the format class. Do not deprecate the object, as the
 
813
    methods on the format class. Do not deprecate the object, as the 
1240
814
    object will be created every time regardless.
1241
815
    """
1242
816
 
1326
900
        control_files.create_lock()
1327
901
        control_files.lock_write()
1328
902
        if set_format:
1329
 
            utf8_files += [('format', self.get_format_string())]
 
903
            control_files.put_utf8('format', self.get_format_string())
1330
904
        try:
1331
 
            for (filename, content) in utf8_files:
1332
 
                branch_transport.put_bytes(
1333
 
                    filename, content,
1334
 
                    mode=a_bzrdir._get_file_mode())
 
905
            for file, content in utf8_files:
 
906
                control_files.put_utf8(file, content)
1335
907
        finally:
1336
908
            control_files.unlock()
1337
909
        return self.open(a_bzrdir, _found=True)
1344
916
        """Is this format supported?
1345
917
 
1346
918
        Supported formats can be initialized and opened.
1347
 
        Unsupported formats may not support initialization or committing or
 
919
        Unsupported formats may not support initialization or committing or 
1348
920
        some other features depending on the reason for not being supported.
1349
921
        """
1350
922
        return True
1351
923
 
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):
 
924
    def open(self, a_bzrdir, _found=False):
1377
925
        """Return the branch object for a_bzrdir
1378
926
 
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.
 
927
        _found is a private parameter, do not use it. It is used to indicate
 
928
               if format probing has already be done.
1384
929
        """
1385
930
        raise NotImplementedError(self.open)
1386
931
 
1387
932
    @classmethod
1388
933
    def register_format(klass, format):
1389
 
        """Register a metadir format."""
1390
934
        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
935
 
1395
936
    @classmethod
1396
937
    def set_default_format(klass, format):
1397
938
        klass._default_format = format
1398
939
 
1399
 
    def supports_stacking(self):
1400
 
        """True if this format records a stacked-on branch."""
1401
 
        return False
1402
 
 
1403
940
    @classmethod
1404
941
    def unregister_format(klass, format):
 
942
        assert klass._formats[format.get_format_string()] is format
1405
943
        del klass._formats[format.get_format_string()]
1406
944
 
1407
945
    def __str__(self):
1408
 
        return self.get_format_description().rstrip()
 
946
        return self.get_format_string().rstrip()
1409
947
 
1410
948
    def supports_tags(self):
1411
949
        """True if this format supports tags stored in the branch"""
1412
950
        return False  # by default
1413
951
 
 
952
    # XXX: Probably doesn't really belong here -- mbp 20070212
 
953
    def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
 
954
            lock_class):
 
955
        branch_transport = a_bzrdir.get_branch_transport(self)
 
956
        control_files = lockable_files.LockableFiles(branch_transport,
 
957
            lock_filename, lock_class)
 
958
        control_files.create_lock()
 
959
        control_files.lock_write()
 
960
        try:
 
961
            for filename, content in utf8_files:
 
962
                control_files.put_utf8(filename, content)
 
963
        finally:
 
964
            control_files.unlock()
 
965
 
1414
966
 
1415
967
class BranchHooks(Hooks):
1416
968
    """A dictionary mapping hook name to a list of callables for branch hooks.
1417
 
 
 
969
    
1418
970
    e.g. ['set_rh'] Is the list of items to be called when the
1419
971
    set_revision_history function is invoked.
1420
972
    """
1426
978
        notified.
1427
979
        """
1428
980
        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))
 
981
        # Introduced in 0.15:
 
982
        # invoked whenever the revision history has been set
 
983
        # with set_revision_history. The api signature is
 
984
        # (branch, revision_history), and the branch will
 
985
        # be write-locked.
 
986
        self['set_rh'] = []
 
987
        # invoked after a push operation completes.
 
988
        # the api signature is
 
989
        # (push_result)
 
990
        # containing the members
 
991
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
992
        # where local is the local target branch or None, master is the target 
 
993
        # master branch, and the rest should be self explanatory. The source
 
994
        # is read locked and the target branches write locked. Source will
 
995
        # be the local low-latency branch.
 
996
        self['post_push'] = []
 
997
        # invoked after a pull operation completes.
 
998
        # the api signature is
 
999
        # (pull_result)
 
1000
        # containing the members
 
1001
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1002
        # where local is the local branch or None, master is the target 
 
1003
        # master branch, and the rest should be self explanatory. The source
 
1004
        # is read locked and the target branches write locked. The local
 
1005
        # branch is the low-latency branch.
 
1006
        self['post_pull'] = []
 
1007
        # invoked before a commit operation takes place.
 
1008
        # the api signature is
 
1009
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1010
        #  tree_delta, future_tree).
 
1011
        # old_revid is NULL_REVISION for the first commit to a branch
 
1012
        # tree_delta is a TreeDelta object describing changes from the basis
 
1013
        # revision, hooks MUST NOT modify this delta
 
1014
        # future_tree is an in-memory tree obtained from
 
1015
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1016
        self['pre_commit'] = []
 
1017
        # invoked after a commit operation completes.
 
1018
        # the api signature is 
 
1019
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1020
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1021
        self['post_commit'] = []
 
1022
        # invoked after a uncommit operation completes.
 
1023
        # the api signature is
 
1024
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1025
        # local is the local branch or None, master is the target branch,
 
1026
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1027
        self['post_uncommit'] = []
1489
1028
 
1490
1029
 
1491
1030
# install the default hooks into the Branch class.
1492
1031
Branch.hooks = BranchHooks()
1493
1032
 
1494
1033
 
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
1034
class BzrBranchFormat4(BranchFormat):
1534
1035
    """Bzr branch format 4.
1535
1036
 
1554
1055
        super(BzrBranchFormat4, self).__init__()
1555
1056
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1556
1057
 
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()
 
1058
    def open(self, a_bzrdir, _found=False):
 
1059
        """Return the branch object for a_bzrdir
1560
1060
 
1561
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1562
 
        """See BranchFormat.open()."""
 
1061
        _found is a private parameter, do not use it. It is used to indicate
 
1062
               if format probing has already be done.
 
1063
        """
1563
1064
        if not _found:
1564
1065
            # we are being called directly and must probe.
1565
1066
            raise NotImplementedError
1572
1073
        return "Bazaar-NG branch format 4"
1573
1074
 
1574
1075
 
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.
1586
 
        """
1587
 
        return self.get_format_string()
1588
 
 
1589
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1590
 
        """See BranchFormat.open()."""
1591
 
        if not _found:
1592
 
            format = BranchFormat.find_format(a_bzrdir)
1593
 
            if format.__class__ != self.__class__:
1594
 
                raise AssertionError("wrong format %r found for %r" %
1595
 
                    (format, self))
1596
 
        try:
1597
 
            transport = a_bzrdir.get_branch_transport(None)
1598
 
            control_files = lockable_files.LockableFiles(transport, 'lock',
1599
 
                                                         lockdir.LockDir)
1600
 
            return self._branch_class()(_format=self,
1601
 
                              _control_files=control_files,
1602
 
                              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):
 
1076
class BzrBranchFormat5(BranchFormat):
1618
1077
    """Bzr branch format 5.
1619
1078
 
1620
1079
    This format has:
1627
1086
    This format is new in bzr 0.8.
1628
1087
    """
1629
1088
 
1630
 
    def _branch_class(self):
1631
 
        return BzrBranch5
1632
 
 
1633
1089
    def get_format_string(self):
1634
1090
        """See BranchFormat.get_format_string()."""
1635
1091
        return "Bazaar-NG branch format 5\n"
1637
1093
    def get_format_description(self):
1638
1094
        """See BranchFormat.get_format_description()."""
1639
1095
        return "Branch format 5"
1640
 
 
 
1096
        
1641
1097
    def initialize(self, a_bzrdir):
1642
1098
        """Create a branch of this format in a_bzrdir."""
1643
1099
        utf8_files = [('revision-history', ''),
1645
1101
                      ]
1646
1102
        return self._initialize_helper(a_bzrdir, utf8_files)
1647
1103
 
1648
 
    def supports_tags(self):
1649
 
        return False
1650
 
 
1651
 
 
1652
 
class BzrBranchFormat6(BranchFormatMetadir):
 
1104
    def __init__(self):
 
1105
        super(BzrBranchFormat5, self).__init__()
 
1106
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1107
 
 
1108
    def open(self, a_bzrdir, _found=False):
 
1109
        """Return the branch object for a_bzrdir
 
1110
 
 
1111
        _found is a private parameter, do not use it. It is used to indicate
 
1112
               if format probing has already be done.
 
1113
        """
 
1114
        if not _found:
 
1115
            format = BranchFormat.find_format(a_bzrdir)
 
1116
            assert format.__class__ == self.__class__
 
1117
        try:
 
1118
            transport = a_bzrdir.get_branch_transport(None)
 
1119
            control_files = lockable_files.LockableFiles(transport, 'lock',
 
1120
                                                         lockdir.LockDir)
 
1121
            return BzrBranch5(_format=self,
 
1122
                              _control_files=control_files,
 
1123
                              a_bzrdir=a_bzrdir,
 
1124
                              _repository=a_bzrdir.find_repository())
 
1125
        except errors.NoSuchFile:
 
1126
            raise errors.NotBranchError(path=transport.base)
 
1127
 
 
1128
 
 
1129
class BzrBranchFormat6(BzrBranchFormat5):
1653
1130
    """Branch format with last-revision and tags.
1654
1131
 
1655
1132
    Unlike previous formats, this has no explicit revision history. Instead,
1660
1137
    and became the default in 0.91.
1661
1138
    """
1662
1139
 
1663
 
    def _branch_class(self):
1664
 
        return BzrBranch6
1665
 
 
1666
1140
    def get_format_string(self):
1667
1141
        """See BranchFormat.get_format_string()."""
1668
1142
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
1679
1153
                      ]
1680
1154
        return self._initialize_helper(a_bzrdir, utf8_files)
1681
1155
 
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):
 
1156
    def open(self, a_bzrdir, _found=False):
 
1157
        """Return the branch object for a_bzrdir
 
1158
 
 
1159
        _found is a private parameter, do not use it. It is used to indicate
 
1160
               if format probing has already be done.
 
1161
        """
 
1162
        if not _found:
 
1163
            format = BranchFormat.find_format(a_bzrdir)
 
1164
            assert format.__class__ == self.__class__
 
1165
        transport = a_bzrdir.get_branch_transport(None)
 
1166
        control_files = lockable_files.LockableFiles(transport, 'lock',
 
1167
                                                     lockdir.LockDir)
 
1168
        return BzrBranch6(_format=self,
 
1169
                          _control_files=control_files,
 
1170
                          a_bzrdir=a_bzrdir,
 
1171
                          _repository=a_bzrdir.find_repository())
 
1172
 
 
1173
    def supports_tags(self):
1726
1174
        return True
1727
1175
 
1728
1176
 
1773
1221
    def __init__(self):
1774
1222
        super(BranchReferenceFormat, self).__init__()
1775
1223
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1776
 
        self._matchingbzrdir.set_branch_format(self)
1777
1224
 
1778
1225
    def _make_reference_clone_function(format, a_branch):
1779
1226
        """Create a clone() routine for a branch dynamically."""
1780
 
        def clone(to_bzrdir, revision_id=None,
1781
 
            repository_policy=None):
 
1227
        def clone(to_bzrdir, revision_id=None):
1782
1228
            """See Branch.clone()."""
1783
1229
            return format.initialize(to_bzrdir, a_branch)
1784
1230
            # cannot obey revision_id limits when cloning a reference ...
1787
1233
        return clone
1788
1234
 
1789
1235
    def open(self, a_bzrdir, _found=False, location=None,
1790
 
             possible_transports=None, ignore_fallbacks=False):
 
1236
             possible_transports=None):
1791
1237
        """Return the branch that the branch reference in a_bzrdir points at.
1792
1238
 
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.
 
1239
        _found is a private parameter, do not use it. It is used to indicate
 
1240
               if format probing has already be done.
1802
1241
        """
1803
1242
        if not _found:
1804
1243
            format = BranchFormat.find_format(a_bzrdir)
1805
 
            if format.__class__ != self.__class__:
1806
 
                raise AssertionError("wrong format %r found for %r" %
1807
 
                    (format, self))
 
1244
            assert format.__class__ == self.__class__
1808
1245
        if location is None:
1809
1246
            location = self.get_reference(a_bzrdir)
1810
1247
        real_bzrdir = bzrdir.BzrDir.open(
1811
1248
            location, possible_transports=possible_transports)
1812
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
1249
        result = real_bzrdir.open_branch()
1813
1250
        # this changes the behaviour of result.clone to create a new reference
1814
1251
        # rather than a copy of the content of the branch.
1815
1252
        # I did not use a proxy object because that needs much more extensive
1822
1259
        return result
1823
1260
 
1824
1261
 
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
1262
# formats which have no format string are not discoverable
1835
1263
# and not independently creatable, so are not registered.
1836
1264
__format5 = BzrBranchFormat5()
1837
1265
__format6 = BzrBranchFormat6()
1838
 
__format7 = BzrBranchFormat7()
1839
1266
BranchFormat.register_format(__format5)
1840
1267
BranchFormat.register_format(BranchReferenceFormat())
1841
1268
BranchFormat.register_format(__format6)
1842
 
BranchFormat.register_format(__format7)
1843
1269
BranchFormat.set_default_format(__format6)
1844
1270
_legacy_formats = [BzrBranchFormat4(),
1845
 
    ]
1846
 
network_format_registry.register(
1847
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1848
 
 
 
1271
                   ]
1849
1272
 
1850
1273
class BzrBranch(Branch):
1851
1274
    """A branch stored in the actual filesystem.
1853
1276
    Note that it's "local" in the context of the filesystem; it doesn't
1854
1277
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1855
1278
    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
1279
    """
1863
 
 
 
1280
    
1864
1281
    def __init__(self, _format=None,
1865
 
                 _control_files=None, a_bzrdir=None, _repository=None,
1866
 
                 ignore_fallbacks=False):
 
1282
                 _control_files=None, a_bzrdir=None, _repository=None):
1867
1283
        """Create new branch object at a particular location."""
 
1284
        Branch.__init__(self)
1868
1285
        if a_bzrdir is None:
1869
1286
            raise ValueError('a_bzrdir must be supplied')
1870
1287
        else:
1871
1288
            self.bzrdir = a_bzrdir
 
1289
        # self._transport used to point to the directory containing the
 
1290
        # control directory, but was not used - now it's just the transport
 
1291
        # for the branch control files.  mbp 20070212
1872
1292
        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
1293
        self._format = _format
1877
1294
        if _control_files is None:
1878
1295
            raise ValueError('BzrBranch _control_files is None')
1879
1296
        self.control_files = _control_files
1880
1297
        self._transport = _control_files._transport
1881
1298
        self.repository = _repository
1882
 
        Branch.__init__(self)
1883
1299
 
1884
1300
    def __str__(self):
1885
1301
        return '%s(%r)' % (self.__class__.__name__, self.base)
1892
1308
 
1893
1309
    base = property(_get_base, doc="The URL for the root of this branch.")
1894
1310
 
1895
 
    def _get_config(self):
1896
 
        return TransportConfig(self._transport, 'branch.conf')
 
1311
    def abspath(self, name):
 
1312
        """See Branch.abspath."""
 
1313
        return self.control_files._transport.abspath(name)
 
1314
 
 
1315
 
 
1316
    @deprecated_method(zero_sixteen)
 
1317
    @needs_read_lock
 
1318
    def get_root_id(self):
 
1319
        """See Branch.get_root_id."""
 
1320
        tree = self.repository.revision_tree(self.last_revision())
 
1321
        return tree.get_root_id()
1897
1322
 
1898
1323
    def is_locked(self):
1899
1324
        return self.control_files.is_locked()
1924
1349
        if not self.control_files.is_locked():
1925
1350
            # we just released the lock
1926
1351
            self._clear_cached_state()
1927
 
 
 
1352
        
1928
1353
    def peek_lock_mode(self):
1929
1354
        if self.control_files._lock_count == 0:
1930
1355
            return None
1944
1369
 
1945
1370
        This performs the actual writing to disk.
1946
1371
        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())
 
1372
        self.control_files.put_bytes(
 
1373
            'revision-history', '\n'.join(history))
1950
1374
 
1951
1375
    @needs_write_lock
1952
1376
    def set_revision_history(self, rev_history):
1953
1377
        """See Branch.set_revision_history."""
1954
1378
        if 'evil' in debug.debug_flags:
1955
1379
            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)
 
1380
        self._clear_cached_state()
1968
1381
        self._write_revision_history(rev_history)
1969
 
        self._clear_cached_state()
1970
1382
        self._cache_revision_history(rev_history)
1971
1383
        for hook in Branch.hooks['set_rh']:
1972
1384
            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
1385
 
2005
1386
    @needs_write_lock
2006
1387
    def set_last_revision_info(self, revno, revision_id):
2010
1391
        for this revision id.
2011
1392
 
2012
1393
        It may be possible to set the branch last revision to an id not
2013
 
        present in the repository.  However, branches can also be
 
1394
        present in the repository.  However, branches can also be 
2014
1395
        configured to check constraints on history, in which case this may not
2015
1396
        be permitted.
2016
1397
        """
2017
1398
        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
2021
1399
        history = self._lefthand_history(revision_id)
2022
 
        if len(history) != revno:
2023
 
            raise AssertionError('%d != %d' % (len(history), revno))
 
1400
        assert len(history) == revno, '%d != %d' % (len(history), revno)
2024
1401
        self.set_revision_history(history)
2025
1402
 
2026
1403
    def _gen_revision_history(self):
2027
 
        history = self._transport.get_bytes('revision-history').split('\n')
 
1404
        history = self.control_files.get('revision-history').read().split('\n')
2028
1405
        if history[-1:] == ['']:
2029
1406
            # There shouldn't be a trailing newline, but just in case.
2030
1407
            history.pop()
2031
1408
        return history
2032
1409
 
 
1410
    def _lefthand_history(self, revision_id, last_rev=None,
 
1411
                          other_branch=None):
 
1412
        if 'evil' in debug.debug_flags:
 
1413
            mutter_callsite(4, "_lefthand_history scales with history.")
 
1414
        # stop_revision must be a descendant of last_revision
 
1415
        graph = self.repository.get_graph()
 
1416
        if last_rev is not None:
 
1417
            if not graph.is_ancestor(last_rev, revision_id):
 
1418
                # our previous tip is not merged into stop_revision
 
1419
                raise errors.DivergedBranches(self, other_branch)
 
1420
        # make a new revision history from the graph
 
1421
        parents_map = graph.get_parent_map([revision_id])
 
1422
        if revision_id not in parents_map:
 
1423
            raise errors.NoSuchRevision(self, revision_id)
 
1424
        current_rev_id = revision_id
 
1425
        new_history = []
 
1426
        # Do not include ghosts or graph origin in revision_history
 
1427
        while (current_rev_id in parents_map and
 
1428
               len(parents_map[current_rev_id]) > 0):
 
1429
            new_history.append(current_rev_id)
 
1430
            current_rev_id = parents_map[current_rev_id][0]
 
1431
            parents_map = graph.get_parent_map([current_rev_id])
 
1432
        new_history.reverse()
 
1433
        return new_history
 
1434
 
2033
1435
    @needs_write_lock
2034
1436
    def generate_revision_history(self, revision_id, last_rev=None,
2035
1437
        other_branch=None):
2044
1446
        self.set_revision_history(self._lefthand_history(revision_id,
2045
1447
            last_rev, other_branch))
2046
1448
 
 
1449
    @needs_write_lock
 
1450
    def update_revisions(self, other, stop_revision=None, overwrite=False):
 
1451
        """See Branch.update_revisions."""
 
1452
        other.lock_read()
 
1453
        try:
 
1454
            other_last_revno, other_last_revision = other.last_revision_info()
 
1455
            if stop_revision is None:
 
1456
                stop_revision = other_last_revision
 
1457
                if _mod_revision.is_null(stop_revision):
 
1458
                    # if there are no commits, we're done.
 
1459
                    return
 
1460
            # whats the current last revision, before we fetch [and change it
 
1461
            # possibly]
 
1462
            last_rev = _mod_revision.ensure_null(self.last_revision())
 
1463
            # we fetch here so that we don't process data twice in the common
 
1464
            # case of having something to pull, and so that the check for 
 
1465
            # already merged can operate on the just fetched graph, which will
 
1466
            # be cached in memory.
 
1467
            self.fetch(other, stop_revision)
 
1468
            # Check to see if one is an ancestor of the other
 
1469
            if not overwrite:
 
1470
                heads = self.repository.get_graph().heads([stop_revision,
 
1471
                                                           last_rev])
 
1472
                if heads == set([last_rev]):
 
1473
                    # The current revision is a decendent of the target,
 
1474
                    # nothing to do
 
1475
                    return
 
1476
                elif heads == set([stop_revision, last_rev]):
 
1477
                    # These branches have diverged
 
1478
                    raise errors.DivergedBranches(self, other)
 
1479
                assert heads == set([stop_revision])
 
1480
            if other_last_revision == stop_revision:
 
1481
                self.set_last_revision_info(other_last_revno,
 
1482
                                            other_last_revision)
 
1483
            else:
 
1484
                # TODO: jam 2007-11-29 Is there a way to determine the
 
1485
                #       revno without searching all of history??
 
1486
                if overwrite:
 
1487
                    self.generate_revision_history(stop_revision)
 
1488
                else:
 
1489
                    self.generate_revision_history(stop_revision,
 
1490
                        last_rev=last_rev, other_branch=other)
 
1491
        finally:
 
1492
            other.unlock()
 
1493
 
2047
1494
    def basis_tree(self):
2048
1495
        """See Branch.basis_tree."""
2049
1496
        return self.repository.revision_tree(self.last_revision())
2050
1497
 
2051
1498
    @needs_write_lock
2052
1499
    def pull(self, source, overwrite=False, stop_revision=None,
2053
 
             _hook_master=None, run_hooks=True, possible_transports=None,
2054
 
             _override_hook_target=None):
 
1500
             _hook_master=None, run_hooks=True, possible_transports=None):
2055
1501
        """See Branch.pull.
2056
1502
 
2057
 
        :param _hook_master: Private parameter - set the branch to
2058
 
            be supplied as the master to pull hooks.
 
1503
        :param _hook_master: Private parameter - set the branch to 
 
1504
            be supplied as the master to push hooks.
2059
1505
        :param run_hooks: Private parameter - if false, this branch
2060
1506
            is being called because it's the master of the primary branch,
2061
1507
            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
1508
        """
2065
1509
        result = PullResult()
2066
1510
        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
 
1511
        result.target_branch = self
2071
1512
        source.lock_read()
2072
1513
        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
1514
            result.old_revno, result.old_revid = self.last_revision_info()
2077
 
            self.update_revisions(source, stop_revision, overwrite=overwrite,
2078
 
                                  graph=graph)
 
1515
            self.update_revisions(source, stop_revision, overwrite=overwrite)
2079
1516
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2080
1517
            result.new_revno, result.new_revid = self.last_revision_info()
2081
1518
            if _hook_master:
2082
1519
                result.master_branch = _hook_master
2083
 
                result.local_branch = result.target_branch
 
1520
                result.local_branch = self
2084
1521
            else:
2085
 
                result.master_branch = result.target_branch
 
1522
                result.master_branch = self
2086
1523
                result.local_branch = None
2087
1524
            if run_hooks:
2088
1525
                for hook in Branch.hooks['post_pull']:
2095
1532
        _locs = ['parent', 'pull', 'x-pull']
2096
1533
        for l in _locs:
2097
1534
            try:
2098
 
                return self._transport.get_bytes(l).strip('\n')
 
1535
                return self.control_files.get(l).read().strip('\n')
2099
1536
            except errors.NoSuchFile:
2100
1537
                pass
2101
1538
        return None
2108
1545
        This is the basic concrete implementation of push()
2109
1546
 
2110
1547
        :param _override_hook_source_branch: If specified, run
2111
 
        the hooks passing this Branch as the source, rather than self.
 
1548
        the hooks passing this Branch as the source, rather than self.  
2112
1549
        This is for use of RemoteBranch, where push is delegated to the
2113
 
        underlying vfs-based Branch.
 
1550
        underlying vfs-based Branch. 
2114
1551
        """
2115
1552
        # TODO: Public option to disable running hooks - should be trivial but
2116
1553
        # 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)
 
1554
        target.lock_write()
 
1555
        try:
 
1556
            result = self._push_with_bound_branches(target, overwrite,
 
1557
                    stop_revision,
 
1558
                    _override_hook_source_branch=_override_hook_source_branch)
 
1559
            return result
 
1560
        finally:
 
1561
            target.unlock()
2121
1562
 
2122
1563
    def _push_with_bound_branches(self, target, overwrite,
2123
1564
            stop_revision,
2124
1565
            _override_hook_source_branch=None):
2125
1566
        """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
 
1567
        
 
1568
        This is on the base BzrBranch class even though it doesn't support 
2128
1569
        bound branches because the *target* might be bound.
2129
1570
        """
2130
1571
        def _run_hooks():
2170
1611
 
2171
1612
        Must be called with self read locked and target write locked.
2172
1613
        """
2173
 
        result = BranchPushResult()
 
1614
        result = PushResult()
2174
1615
        result.source_branch = self
2175
1616
        result.target_branch = target
2176
1617
        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)
 
1618
        try:
 
1619
            target.update_revisions(self, stop_revision)
 
1620
        except errors.DivergedBranches:
 
1621
            if not overwrite:
 
1622
                raise
 
1623
        if overwrite:
 
1624
            target.set_revision_history(self.revision_history())
 
1625
        result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2185
1626
        result.new_revno, result.new_revid = target.last_revision_info()
2186
1627
        return result
2187
1628
 
2188
 
    def get_stacked_on_url(self):
2189
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1629
    def get_parent(self):
 
1630
        """See Branch.get_parent."""
 
1631
 
 
1632
        assert self.base[-1] == '/'
 
1633
        parent = self._get_parent_location()
 
1634
        if parent is None:
 
1635
            return parent
 
1636
        # This is an old-format absolute path to a local branch
 
1637
        # turn it into a url
 
1638
        if parent.startswith('/'):
 
1639
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1640
        try:
 
1641
            return urlutils.join(self.base[:-1], parent)
 
1642
        except errors.InvalidURLJoin, e:
 
1643
            raise errors.InaccessibleParent(parent, self.base)
2190
1644
 
2191
1645
    def set_push_location(self, location):
2192
1646
        """See Branch.set_push_location."""
2200
1654
        # TODO: Maybe delete old location files?
2201
1655
        # URLs should never be unicode, even on the local fs,
2202
1656
        # FIXUP this and get_parent in a future branch format bump:
2203
 
        # read and rewrite the file. RBC 20060125
 
1657
        # read and rewrite the file, and have the new format code read
 
1658
        # using .get not .get_utf8. RBC 20060125
2204
1659
        if url is not None:
2205
1660
            if isinstance(url, unicode):
2206
 
                try:
 
1661
                try: 
2207
1662
                    url = url.encode('ascii')
2208
1663
                except UnicodeEncodeError:
2209
1664
                    raise errors.InvalidURL(url,
2214
1669
 
2215
1670
    def _set_parent_location(self, url):
2216
1671
        if url is None:
2217
 
            self._transport.delete('parent')
 
1672
            self.control_files._transport.delete('parent')
2218
1673
        else:
2219
 
            self._transport.put_bytes('parent', url + '\n',
2220
 
                mode=self.bzrdir._get_file_mode())
 
1674
            assert isinstance(url, str)
 
1675
            self.control_files.put_bytes('parent', url + '\n')
2221
1676
 
2222
1677
 
2223
1678
class BzrBranch5(BzrBranch):
2226
1681
    It has support for a master_branch which is the data for bound branches.
2227
1682
    """
2228
1683
 
 
1684
    def __init__(self,
 
1685
                 _format,
 
1686
                 _control_files,
 
1687
                 a_bzrdir,
 
1688
                 _repository):
 
1689
        super(BzrBranch5, self).__init__(_format=_format,
 
1690
                                         _control_files=_control_files,
 
1691
                                         a_bzrdir=a_bzrdir,
 
1692
                                         _repository=_repository)
 
1693
        
2229
1694
    @needs_write_lock
2230
1695
    def pull(self, source, overwrite=False, stop_revision=None,
2231
 
             run_hooks=True, possible_transports=None,
2232
 
             _override_hook_target=None):
 
1696
             run_hooks=True, possible_transports=None):
2233
1697
        """Pull from source into self, updating my master if any.
2234
 
 
 
1698
        
2235
1699
        :param run_hooks: Private parameter - if false, this branch
2236
1700
            is being called because it's the master of the primary branch,
2237
1701
            so it should not run its hooks.
2249
1713
                    run_hooks=False)
2250
1714
            return super(BzrBranch5, self).pull(source, overwrite,
2251
1715
                stop_revision, _hook_master=master_branch,
2252
 
                run_hooks=run_hooks,
2253
 
                _override_hook_target=_override_hook_target)
 
1716
                run_hooks=run_hooks)
2254
1717
        finally:
2255
1718
            if master_branch:
2256
1719
                master_branch.unlock()
2257
1720
 
2258
1721
    def get_bound_location(self):
2259
1722
        try:
2260
 
            return self._transport.get_bytes('bound')[:-1]
 
1723
            return self.control_files.get_utf8('bound').read()[:-1]
2261
1724
        except errors.NoSuchFile:
2262
1725
            return None
2263
1726
 
2264
1727
    @needs_read_lock
2265
1728
    def get_master_branch(self, possible_transports=None):
2266
1729
        """Return the branch we are bound to.
2267
 
 
 
1730
        
2268
1731
        :return: Either a Branch, or None
2269
1732
 
2270
1733
        This could memoise the branch, but if thats done
2289
1752
        :param location: URL to the target branch
2290
1753
        """
2291
1754
        if location:
2292
 
            self._transport.put_bytes('bound', location+'\n',
2293
 
                mode=self.bzrdir._get_file_mode())
 
1755
            self.control_files.put_utf8('bound', location+'\n')
2294
1756
        else:
2295
1757
            try:
2296
 
                self._transport.delete('bound')
 
1758
                self.control_files._transport.delete('bound')
2297
1759
            except errors.NoSuchFile:
2298
1760
                return False
2299
1761
            return True
2306
1768
        check for divergence to raise an error when the branches are not
2307
1769
        either the same, or one a prefix of the other. That behaviour may not
2308
1770
        be useful, so that check may be removed in future.
2309
 
 
 
1771
        
2310
1772
        :param other: The branch to bind to
2311
1773
        :type other: Branch
2312
1774
        """
2331
1793
 
2332
1794
    @needs_write_lock
2333
1795
    def update(self, possible_transports=None):
2334
 
        """Synchronise this branch with the master branch if any.
 
1796
        """Synchronise this branch with the master branch if any. 
2335
1797
 
2336
1798
        :return: None or the last_revision that was pivoted out during the
2337
1799
                 update.
2347
1809
        return None
2348
1810
 
2349
1811
 
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
2356
 
        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')
 
1812
class BzrBranch6(BzrBranch5):
 
1813
 
 
1814
    @needs_read_lock
 
1815
    def last_revision_info(self):
 
1816
        revision_string = self.control_files.get('last-revision').read()
2384
1817
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2385
1818
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2386
1819
        revno = int(revno)
2395
1828
        Intended to be called by set_last_revision_info and
2396
1829
        _write_revision_history.
2397
1830
        """
2398
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
1831
        assert revision_id is not None, "Use NULL_REVISION, not None"
2399
1832
        out_string = '%d %s\n' % (revno, revision_id)
2400
 
        self._transport.put_bytes('last-revision', out_string,
2401
 
            mode=self.bzrdir._get_file_mode())
 
1833
        self.control_files.put_bytes('last-revision', out_string)
2402
1834
 
2403
1835
    @needs_write_lock
2404
1836
    def set_last_revision_info(self, revno, revision_id):
2405
1837
        revision_id = _mod_revision.ensure_null(revision_id)
2406
 
        old_revno, old_revid = self.last_revision_info()
2407
1838
        if self._get_append_revisions_only():
2408
1839
            self._check_history_violation(revision_id)
2409
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2410
1840
        self._write_last_revision_info(revno, revision_id)
2411
1841
        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
1842
 
2427
1843
    def _check_history_violation(self, revision_id):
2428
1844
        last_revision = _mod_revision.ensure_null(self.last_revision())
2434
1850
    def _gen_revision_history(self):
2435
1851
        """Generate the revision history from last revision
2436
1852
        """
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
 
1853
        history = list(self.repository.iter_reverse_revision_history(
 
1854
            self.last_revision()))
 
1855
        history.reverse()
 
1856
        return history
2469
1857
 
2470
1858
    def _write_revision_history(self, history):
2471
1859
        """Factored out of set_revision_history.
2531
1919
        """See Branch.get_old_bound_location"""
2532
1920
        return self._get_bound_location(False)
2533
1921
 
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
1922
    def set_append_revisions_only(self, enabled):
2544
1923
        if enabled:
2545
1924
            value = 'True'
2552
1931
        value = self.get_config().get_user_option('append_revisions_only')
2553
1932
        return value == 'True'
2554
1933
 
 
1934
    def _synchronize_history(self, destination, revision_id):
 
1935
        """Synchronize last revision and revision history between branches.
 
1936
 
 
1937
        This version is most efficient when the destination is also a
 
1938
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
1939
        repository contains all the lefthand ancestors of the intended
 
1940
        last_revision.  If not, set_last_revision_info will fail.
 
1941
 
 
1942
        :param destination: The branch to copy the history into
 
1943
        :param revision_id: The revision-id to truncate history at.  May
 
1944
          be None to copy complete history.
 
1945
        """
 
1946
        source_revno, source_revision_id = self.last_revision_info()
 
1947
        if revision_id is None:
 
1948
            revno, revision_id = source_revno, source_revision_id
 
1949
        elif source_revision_id == revision_id:
 
1950
            # we know the revno without needing to walk all of history
 
1951
            revno = source_revno
 
1952
        else:
 
1953
            # To figure out the revno for a random revision, we need to build
 
1954
            # the revision history, and count its length.
 
1955
            # We don't care about the order, just how long it is.
 
1956
            # Alternatively, we could start at the current location, and count
 
1957
            # backwards. But there is no guarantee that we will find it since
 
1958
            # it may be a merged revision.
 
1959
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1960
                                                                revision_id)))
 
1961
        destination.set_last_revision_info(revno, revision_id)
 
1962
 
 
1963
    def _make_tags(self):
 
1964
        return BasicTags(self)
 
1965
 
2555
1966
    @needs_write_lock
2556
1967
    def generate_revision_history(self, revision_id, last_rev=None,
2557
1968
                                  other_branch=None):
2560
1971
        revno = len(history)
2561
1972
        self.set_last_revision_info(revno, revision_id)
2562
1973
 
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]
2581
 
        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)
2608
 
 
2609
1974
 
2610
1975
######################################################################
2611
1976
# results of operations
2628
1993
    :ivar new_revno: Revision number after pull.
2629
1994
    :ivar old_revid: Tip revision id before pull.
2630
1995
    :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
 
1996
    :ivar source_branch: Source (local) branch object.
 
1997
    :ivar master_branch: Master branch of the target, or None.
 
1998
    :ivar target_branch: Target/destination branch object.
2637
1999
    """
2638
2000
 
2639
2001
    def __int__(self):
2649
2011
        self._show_tag_conficts(to_file)
2650
2012
 
2651
2013
 
2652
 
class BranchPushResult(_Result):
 
2014
class PushResult(_Result):
2653
2015
    """Result of a Branch.push operation.
2654
2016
 
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.
 
2017
    :ivar old_revno: Revision number before push.
 
2018
    :ivar new_revno: Revision number after push.
 
2019
    :ivar old_revid: Tip revision id before push.
 
2020
    :ivar new_revid: Tip revision id after push.
 
2021
    :ivar source_branch: Source branch object.
 
2022
    :ivar master_branch: Master branch of the target, or None.
 
2023
    :ivar target_branch: Target/destination branch object.
2669
2024
    """
2670
2025
 
2671
2026
    def __int__(self):
2675
2030
    def report(self, to_file):
2676
2031
        """Write a human-readable description of the result."""
2677
2032
        if self.old_revid == self.new_revid:
2678
 
            note('No new revisions to push.')
 
2033
            to_file.write('No new revisions to push.\n')
2679
2034
        else:
2680
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2035
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2681
2036
        self._show_tag_conficts(to_file)
2682
2037
 
2683
2038
 
2692
2047
 
2693
2048
    def report_results(self, verbose):
2694
2049
        """Report the check results via trace.note.
2695
 
 
 
2050
        
2696
2051
        :param verbose: Requests more detailed display of what was checked,
2697
2052
            if any.
2698
2053
        """
2710
2065
        new_branch = format.open(branch.bzrdir, _found=True)
2711
2066
 
2712
2067
        # Copy source data into target
2713
 
        new_branch._write_last_revision_info(*branch.last_revision_info())
 
2068
        new_branch.set_last_revision_info(*branch.last_revision_info())
2714
2069
        new_branch.set_parent(branch.get_parent())
2715
2070
        new_branch.set_bound_location(branch.get_bound_location())
2716
2071
        new_branch.set_push_location(branch.get_push_location())
2719
2074
        new_branch.tags._set_tag_dict({})
2720
2075
 
2721
2076
        # 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())
 
2077
        new_branch.control_files.put_utf8('format',
 
2078
            format.get_format_string())
2725
2079
 
2726
2080
        # Clean up old files
2727
 
        new_branch._transport.delete('revision-history')
 
2081
        new_branch.control_files._transport.delete('revision-history')
2728
2082
        try:
2729
2083
            branch.set_parent(None)
2730
2084
        except errors.NoSuchFile:
2731
2085
            pass
2732
2086
        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)