/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: John Arbash Meinel
  • Date: 2009-05-27 15:39:12 UTC
  • mto: This revision was merged to the branch mainline in revision 4392.
  • Revision ID: john@arbash-meinel.com-20090527153912-rmlhgzxx12zqw33e
Add tests that when resuming a write group, we start checking if
there are missing texts, in order to determine if there are missing inventories.

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