/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2009-05-15 02:36:03 UTC
  • mto: This revision was merged to the branch mainline in revision 4369.
  • Revision ID: jelmer@samba.org-20090515023603-x7jsmtb5h66y7efp
Import malloc and friends from stdlib.h rather than from (deprecated) malloc.h.

Show diffs side-by-side

added added

removed removed

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