/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: Marius Kruger
  • Date: 2008-11-18 21:50:10 UTC
  • mto: This revision was merged to the branch mainline in revision 3863.
  • Revision ID: amanic@gmail.com-20081118215010-m679n8qlpc2v2jdj
When doing a `commit --local`, don't try to connect to the master branch.
(Includes a new test for this)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import sys
 
19
 
 
20
from bzrlib.lazy_import import lazy_import
 
21
lazy_import(globals(), """
 
22
from itertools import chain
 
23
from bzrlib import (
 
24
        bzrdir,
 
25
        cache_utf8,
 
26
        config as _mod_config,
 
27
        debug,
 
28
        errors,
 
29
        lockdir,
 
30
        lockable_files,
 
31
        repository,
 
32
        revision as _mod_revision,
 
33
        transport,
 
34
        tsort,
 
35
        ui,
 
36
        urlutils,
 
37
        )
 
38
from bzrlib.config import BranchConfig
 
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
40
from bzrlib.tag import (
 
41
    BasicTags,
 
42
    DisabledTags,
 
43
    )
 
44
""")
 
45
 
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
 
48
from bzrlib.symbol_versioning import (
 
49
    deprecated_in,
 
50
    deprecated_method,
 
51
    )
 
52
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
 
53
 
 
54
 
 
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
58
 
 
59
 
 
60
# TODO: Maybe include checks for common corruption of newlines, etc?
 
61
 
 
62
# TODO: Some operations like log might retrieve the same revisions
 
63
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
64
# cache in memory to make this faster.  In general anything can be
 
65
# cached in memory between lock and unlock operations. .. nb thats
 
66
# what the transaction identity map provides
 
67
 
 
68
 
 
69
######################################################################
 
70
# branch objects
 
71
 
 
72
class Branch(object):
 
73
    """Branch holding a history of revisions.
 
74
 
 
75
    base
 
76
        Base directory/url of the branch.
 
77
 
 
78
    hooks: An instance of BranchHooks.
 
79
    """
 
80
    # this is really an instance variable - FIXME move it there
 
81
    # - RBC 20060112
 
82
    base = None
 
83
 
 
84
    # override this to set the strategy for storing tags
 
85
    def _make_tags(self):
 
86
        return DisabledTags(self)
 
87
 
 
88
    def __init__(self, *ignored, **ignored_too):
 
89
        self.tags = self._make_tags()
 
90
        self._revision_history_cache = None
 
91
        self._revision_id_to_revno_cache = None
 
92
        self._last_revision_info_cache = None
 
93
        self._open_hook()
 
94
        hooks = Branch.hooks['open']
 
95
        for hook in hooks:
 
96
            hook(self)
 
97
 
 
98
    def _open_hook(self):
 
99
        """Called by init to allow simpler extension of the base class."""
 
100
 
 
101
    def break_lock(self):
 
102
        """Break a lock if one is present from another instance.
 
103
 
 
104
        Uses the ui factory to ask for confirmation if the lock may be from
 
105
        an active process.
 
106
 
 
107
        This will probe the repository for its lock as well.
 
108
        """
 
109
        self.control_files.break_lock()
 
110
        self.repository.break_lock()
 
111
        master = self.get_master_branch()
 
112
        if master is not None:
 
113
            master.break_lock()
 
114
 
 
115
    @staticmethod
 
116
    def open(base, _unsupported=False, possible_transports=None):
 
117
        """Open the branch rooted at base.
 
118
 
 
119
        For instance, if the branch is at URL/.bzr/branch,
 
120
        Branch.open(URL) -> a Branch instance.
 
121
        """
 
122
        control = bzrdir.BzrDir.open(base, _unsupported,
 
123
                                     possible_transports=possible_transports)
 
124
        return control.open_branch(_unsupported)
 
125
 
 
126
    @staticmethod
 
127
    def open_from_transport(transport, _unsupported=False):
 
128
        """Open the branch rooted at transport"""
 
129
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
 
130
        return control.open_branch(_unsupported)
 
131
 
 
132
    @staticmethod
 
133
    def open_containing(url, possible_transports=None):
 
134
        """Open an existing branch which contains url.
 
135
        
 
136
        This probes for a branch at url, and searches upwards from there.
 
137
 
 
138
        Basically we keep looking up until we find the control directory or
 
139
        run into the root.  If there isn't one, raises NotBranchError.
 
140
        If there is one and it is either an unrecognised format or an unsupported 
 
141
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
142
        If there is one, it is returned, along with the unused portion of url.
 
143
        """
 
144
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
145
                                                         possible_transports)
 
146
        return control.open_branch(), relpath
 
147
 
 
148
    def get_config(self):
 
149
        return BranchConfig(self)
 
150
 
 
151
    def _get_nick(self, local=False, possible_transports=None):
 
152
        config = self.get_config()
 
153
        # explicit overrides master, but don't look for master if local is True
 
154
        if not local and not config.has_explicit_nickname():
 
155
            try:
 
156
                master = self.get_master_branch(possible_transports)
 
157
                if master is not None:
 
158
                    # return the master branch value
 
159
                    return master.nick
 
160
            except errors.BzrError, e:
 
161
                # Silently fall back to local implicit nick if the master is
 
162
                # unavailable
 
163
                mutter("Could not connect to bound branch, "
 
164
                    "falling back to local nick.\n " + str(e))
 
165
        return config.get_nickname()
 
166
 
 
167
    def _set_nick(self, nick):
 
168
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
 
169
 
 
170
    nick = property(_get_nick, _set_nick)
 
171
 
 
172
    def is_locked(self):
 
173
        raise NotImplementedError(self.is_locked)
 
174
 
 
175
    def lock_write(self):
 
176
        raise NotImplementedError(self.lock_write)
 
177
 
 
178
    def lock_read(self):
 
179
        raise NotImplementedError(self.lock_read)
 
180
 
 
181
    def unlock(self):
 
182
        raise NotImplementedError(self.unlock)
 
183
 
 
184
    def peek_lock_mode(self):
 
185
        """Return lock mode for the Branch: 'r', 'w' or None"""
 
186
        raise NotImplementedError(self.peek_lock_mode)
 
187
 
 
188
    def get_physical_lock_status(self):
 
189
        raise NotImplementedError(self.get_physical_lock_status)
 
190
 
 
191
    @needs_read_lock
 
192
    def get_revision_id_to_revno_map(self):
 
193
        """Return the revision_id => dotted revno map.
 
194
 
 
195
        This will be regenerated on demand, but will be cached.
 
196
 
 
197
        :return: A dictionary mapping revision_id => dotted revno.
 
198
            This dictionary should not be modified by the caller.
 
199
        """
 
200
        if self._revision_id_to_revno_cache is not None:
 
201
            mapping = self._revision_id_to_revno_cache
 
202
        else:
 
203
            mapping = self._gen_revno_map()
 
204
            self._cache_revision_id_to_revno(mapping)
 
205
        # TODO: jam 20070417 Since this is being cached, should we be returning
 
206
        #       a copy?
 
207
        # I would rather not, and instead just declare that users should not
 
208
        # modify the return value.
 
209
        return mapping
 
210
 
 
211
    def _gen_revno_map(self):
 
212
        """Create a new mapping from revision ids to dotted revnos.
 
213
 
 
214
        Dotted revnos are generated based on the current tip in the revision
 
215
        history.
 
216
        This is the worker function for get_revision_id_to_revno_map, which
 
217
        just caches the return value.
 
218
 
 
219
        :return: A dictionary mapping revision_id => dotted revno.
 
220
        """
 
221
        last_revision = self.last_revision()
 
222
        revision_graph = repository._old_get_graph(self.repository,
 
223
            last_revision)
 
224
        merge_sorted_revisions = tsort.merge_sort(
 
225
            revision_graph,
 
226
            last_revision,
 
227
            None,
 
228
            generate_revno=True)
 
229
        revision_id_to_revno = dict((rev_id, revno)
 
230
                                    for seq_num, rev_id, depth, revno, end_of_merge
 
231
                                     in merge_sorted_revisions)
 
232
        return revision_id_to_revno
 
233
 
 
234
    def leave_lock_in_place(self):
 
235
        """Tell this branch object not to release the physical lock when this
 
236
        object is unlocked.
 
237
        
 
238
        If lock_write doesn't return a token, then this method is not supported.
 
239
        """
 
240
        self.control_files.leave_in_place()
 
241
 
 
242
    def dont_leave_lock_in_place(self):
 
243
        """Tell this branch object to release the physical lock when this
 
244
        object is unlocked, even if it didn't originally acquire it.
 
245
 
 
246
        If lock_write doesn't return a token, then this method is not supported.
 
247
        """
 
248
        self.control_files.dont_leave_in_place()
 
249
 
 
250
    def bind(self, other):
 
251
        """Bind the local branch the other branch.
 
252
 
 
253
        :param other: The branch to bind to
 
254
        :type other: Branch
 
255
        """
 
256
        raise errors.UpgradeRequired(self.base)
 
257
 
 
258
    @needs_write_lock
 
259
    def fetch(self, from_branch, last_revision=None, pb=None):
 
260
        """Copy revisions from from_branch into this branch.
 
261
 
 
262
        :param from_branch: Where to copy from.
 
263
        :param last_revision: What revision to stop at (None for at the end
 
264
                              of the branch.
 
265
        :param pb: An optional progress bar to use.
 
266
 
 
267
        Returns the copied revision count and the failed revisions in a tuple:
 
268
        (copied, failures).
 
269
        """
 
270
        if self.base == from_branch.base:
 
271
            return (0, [])
 
272
        if pb is None:
 
273
            nested_pb = ui.ui_factory.nested_progress_bar()
 
274
            pb = nested_pb
 
275
        else:
 
276
            nested_pb = None
 
277
 
 
278
        from_branch.lock_read()
 
279
        try:
 
280
            if last_revision is None:
 
281
                pb.update('get source history')
 
282
                last_revision = from_branch.last_revision()
 
283
                last_revision = _mod_revision.ensure_null(last_revision)
 
284
            return self.repository.fetch(from_branch.repository,
 
285
                                         revision_id=last_revision,
 
286
                                         pb=nested_pb)
 
287
        finally:
 
288
            if nested_pb is not None:
 
289
                nested_pb.finished()
 
290
            from_branch.unlock()
 
291
 
 
292
    def get_bound_location(self):
 
293
        """Return the URL of the branch we are bound to.
 
294
 
 
295
        Older format branches cannot bind, please be sure to use a metadir
 
296
        branch.
 
297
        """
 
298
        return None
 
299
    
 
300
    def get_old_bound_location(self):
 
301
        """Return the URL of the branch we used to be bound to
 
302
        """
 
303
        raise errors.UpgradeRequired(self.base)
 
304
 
 
305
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
306
                           timezone=None, committer=None, revprops=None, 
 
307
                           revision_id=None):
 
308
        """Obtain a CommitBuilder for this branch.
 
309
        
 
310
        :param parents: Revision ids of the parents of the new revision.
 
311
        :param config: Optional configuration to use.
 
312
        :param timestamp: Optional timestamp recorded for commit.
 
313
        :param timezone: Optional timezone for timestamp.
 
314
        :param committer: Optional committer to set for commit.
 
315
        :param revprops: Optional dictionary of revision properties.
 
316
        :param revision_id: Optional revision id.
 
317
        """
 
318
 
 
319
        if config is None:
 
320
            config = self.get_config()
 
321
        
 
322
        return self.repository.get_commit_builder(self, parents, config,
 
323
            timestamp, timezone, committer, revprops, revision_id)
 
324
 
 
325
    def get_master_branch(self, possible_transports=None):
 
326
        """Return the branch we are bound to.
 
327
        
 
328
        :return: Either a Branch, or None
 
329
        """
 
330
        return None
 
331
 
 
332
    def get_revision_delta(self, revno):
 
333
        """Return the delta for one revision.
 
334
 
 
335
        The delta is relative to its mainline predecessor, or the
 
336
        empty tree for revision 1.
 
337
        """
 
338
        rh = self.revision_history()
 
339
        if not (1 <= revno <= len(rh)):
 
340
            raise errors.InvalidRevisionNumber(revno)
 
341
        return self.repository.get_revision_delta(rh[revno-1])
 
342
 
 
343
    def get_stacked_on_url(self):
 
344
        """Get the URL this branch is stacked against.
 
345
 
 
346
        :raises NotStacked: If the branch is not stacked.
 
347
        :raises UnstackableBranchFormat: If the branch does not support
 
348
            stacking.
 
349
        """
 
350
        raise NotImplementedError(self.get_stacked_on_url)
 
351
 
 
352
    def print_file(self, file, revision_id):
 
353
        """Print `file` to stdout."""
 
354
        raise NotImplementedError(self.print_file)
 
355
 
 
356
    def set_revision_history(self, rev_history):
 
357
        raise NotImplementedError(self.set_revision_history)
 
358
 
 
359
    def set_stacked_on_url(self, url):
 
360
        """Set the URL this branch is stacked against.
 
361
 
 
362
        :raises UnstackableBranchFormat: If the branch does not support
 
363
            stacking.
 
364
        :raises UnstackableRepositoryFormat: If the repository does not support
 
365
            stacking.
 
366
        """
 
367
        raise NotImplementedError(self.set_stacked_on_url)
 
368
 
 
369
    def _cache_revision_history(self, rev_history):
 
370
        """Set the cached revision history to rev_history.
 
371
 
 
372
        The revision_history method will use this cache to avoid regenerating
 
373
        the revision history.
 
374
 
 
375
        This API is semi-public; it only for use by subclasses, all other code
 
376
        should consider it to be private.
 
377
        """
 
378
        self._revision_history_cache = rev_history
 
379
 
 
380
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
 
381
        """Set the cached revision_id => revno map to revision_id_to_revno.
 
382
 
 
383
        This API is semi-public; it only for use by subclasses, all other code
 
384
        should consider it to be private.
 
385
        """
 
386
        self._revision_id_to_revno_cache = revision_id_to_revno
 
387
 
 
388
    def _clear_cached_state(self):
 
389
        """Clear any cached data on this branch, e.g. cached revision history.
 
390
 
 
391
        This means the next call to revision_history will need to call
 
392
        _gen_revision_history.
 
393
 
 
394
        This API is semi-public; it only for use by subclasses, all other code
 
395
        should consider it to be private.
 
396
        """
 
397
        self._revision_history_cache = None
 
398
        self._revision_id_to_revno_cache = None
 
399
        self._last_revision_info_cache = None
 
400
 
 
401
    def _gen_revision_history(self):
 
402
        """Return sequence of revision hashes on to this branch.
 
403
        
 
404
        Unlike revision_history, this method always regenerates or rereads the
 
405
        revision history, i.e. it does not cache the result, so repeated calls
 
406
        may be expensive.
 
407
 
 
408
        Concrete subclasses should override this instead of revision_history so
 
409
        that subclasses do not need to deal with caching logic.
 
410
        
 
411
        This API is semi-public; it only for use by subclasses, all other code
 
412
        should consider it to be private.
 
413
        """
 
414
        raise NotImplementedError(self._gen_revision_history)
 
415
 
 
416
    @needs_read_lock
 
417
    def revision_history(self):
 
418
        """Return sequence of revision ids on this branch.
 
419
        
 
420
        This method will cache the revision history for as long as it is safe to
 
421
        do so.
 
422
        """
 
423
        if 'evil' in debug.debug_flags:
 
424
            mutter_callsite(3, "revision_history scales with history.")
 
425
        if self._revision_history_cache is not None:
 
426
            history = self._revision_history_cache
 
427
        else:
 
428
            history = self._gen_revision_history()
 
429
            self._cache_revision_history(history)
 
430
        return list(history)
 
431
 
 
432
    def revno(self):
 
433
        """Return current revision number for this branch.
 
434
 
 
435
        That is equivalent to the number of revisions committed to
 
436
        this branch.
 
437
        """
 
438
        return self.last_revision_info()[0]
 
439
 
 
440
    def unbind(self):
 
441
        """Older format branches cannot bind or unbind."""
 
442
        raise errors.UpgradeRequired(self.base)
 
443
 
 
444
    def set_append_revisions_only(self, enabled):
 
445
        """Older format branches are never restricted to append-only"""
 
446
        raise errors.UpgradeRequired(self.base)
 
447
 
 
448
    def last_revision(self):
 
449
        """Return last revision id, or NULL_REVISION."""
 
450
        return self.last_revision_info()[1]
 
451
 
 
452
    @needs_read_lock
 
453
    def last_revision_info(self):
 
454
        """Return information about the last revision.
 
455
 
 
456
        :return: A tuple (revno, revision_id).
 
457
        """
 
458
        if self._last_revision_info_cache is None:
 
459
            self._last_revision_info_cache = self._last_revision_info()
 
460
        return self._last_revision_info_cache
 
461
 
 
462
    def _last_revision_info(self):
 
463
        rh = self.revision_history()
 
464
        revno = len(rh)
 
465
        if revno:
 
466
            return (revno, rh[-1])
 
467
        else:
 
468
            return (0, _mod_revision.NULL_REVISION)
 
469
 
 
470
    @deprecated_method(deprecated_in((1, 6, 0)))
 
471
    def missing_revisions(self, other, stop_revision=None):
 
472
        """Return a list of new revisions that would perfectly fit.
 
473
        
 
474
        If self and other have not diverged, return a list of the revisions
 
475
        present in other, but missing from self.
 
476
        """
 
477
        self_history = self.revision_history()
 
478
        self_len = len(self_history)
 
479
        other_history = other.revision_history()
 
480
        other_len = len(other_history)
 
481
        common_index = min(self_len, other_len) -1
 
482
        if common_index >= 0 and \
 
483
            self_history[common_index] != other_history[common_index]:
 
484
            raise errors.DivergedBranches(self, other)
 
485
 
 
486
        if stop_revision is None:
 
487
            stop_revision = other_len
 
488
        else:
 
489
            if stop_revision > other_len:
 
490
                raise errors.NoSuchRevision(self, stop_revision)
 
491
        return other_history[self_len:stop_revision]
 
492
 
 
493
    @needs_write_lock
 
494
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
495
                         graph=None):
 
496
        """Pull in new perfect-fit revisions.
 
497
 
 
498
        :param other: Another Branch to pull from
 
499
        :param stop_revision: Updated until the given revision
 
500
        :param overwrite: Always set the branch pointer, rather than checking
 
501
            to see if it is a proper descendant.
 
502
        :param graph: A Graph object that can be used to query history
 
503
            information. This can be None.
 
504
        :return: None
 
505
        """
 
506
        other.lock_read()
 
507
        try:
 
508
            other_revno, other_last_revision = other.last_revision_info()
 
509
            stop_revno = None # unknown
 
510
            if stop_revision is None:
 
511
                stop_revision = other_last_revision
 
512
                if _mod_revision.is_null(stop_revision):
 
513
                    # if there are no commits, we're done.
 
514
                    return
 
515
                stop_revno = other_revno
 
516
 
 
517
            # what's the current last revision, before we fetch [and change it
 
518
            # possibly]
 
519
            last_rev = _mod_revision.ensure_null(self.last_revision())
 
520
            # we fetch here so that we don't process data twice in the common
 
521
            # case of having something to pull, and so that the check for 
 
522
            # already merged can operate on the just fetched graph, which will
 
523
            # be cached in memory.
 
524
            self.fetch(other, stop_revision)
 
525
            # Check to see if one is an ancestor of the other
 
526
            if not overwrite:
 
527
                if graph is None:
 
528
                    graph = self.repository.get_graph()
 
529
                if self._check_if_descendant_or_diverged(
 
530
                        stop_revision, last_rev, graph, other):
 
531
                    # stop_revision is a descendant of last_rev, but we aren't
 
532
                    # overwriting, so we're done.
 
533
                    return
 
534
            if stop_revno is None:
 
535
                if graph is None:
 
536
                    graph = self.repository.get_graph()
 
537
                this_revno, this_last_revision = self.last_revision_info()
 
538
                stop_revno = graph.find_distance_to_null(stop_revision,
 
539
                                [(other_last_revision, other_revno),
 
540
                                 (this_last_revision, this_revno)])
 
541
            self.set_last_revision_info(stop_revno, stop_revision)
 
542
        finally:
 
543
            other.unlock()
 
544
 
 
545
    def revision_id_to_revno(self, revision_id):
 
546
        """Given a revision id, return its revno"""
 
547
        if _mod_revision.is_null(revision_id):
 
548
            return 0
 
549
        history = self.revision_history()
 
550
        try:
 
551
            return history.index(revision_id) + 1
 
552
        except ValueError:
 
553
            raise errors.NoSuchRevision(self, revision_id)
 
554
 
 
555
    def get_rev_id(self, revno, history=None):
 
556
        """Find the revision id of the specified revno."""
 
557
        if revno == 0:
 
558
            return _mod_revision.NULL_REVISION
 
559
        if history is None:
 
560
            history = self.revision_history()
 
561
        if revno <= 0 or revno > len(history):
 
562
            raise errors.NoSuchRevision(self, revno)
 
563
        return history[revno - 1]
 
564
 
 
565
    def pull(self, source, overwrite=False, stop_revision=None,
 
566
             possible_transports=None, _override_hook_target=None):
 
567
        """Mirror source into this branch.
 
568
 
 
569
        This branch is considered to be 'local', having low latency.
 
570
 
 
571
        :returns: PullResult instance
 
572
        """
 
573
        raise NotImplementedError(self.pull)
 
574
 
 
575
    def push(self, target, overwrite=False, stop_revision=None):
 
576
        """Mirror this branch into target.
 
577
 
 
578
        This branch is considered to be 'local', having low latency.
 
579
        """
 
580
        raise NotImplementedError(self.push)
 
581
 
 
582
    def basis_tree(self):
 
583
        """Return `Tree` object for last revision."""
 
584
        return self.repository.revision_tree(self.last_revision())
 
585
 
 
586
    def get_parent(self):
 
587
        """Return the parent location of the branch.
 
588
 
 
589
        This is the default location for push/pull/missing.  The usual
 
590
        pattern is that the user can override it by specifying a
 
591
        location.
 
592
        """
 
593
        raise NotImplementedError(self.get_parent)
 
594
 
 
595
    def _set_config_location(self, name, url, config=None,
 
596
                             make_relative=False):
 
597
        if config is None:
 
598
            config = self.get_config()
 
599
        if url is None:
 
600
            url = ''
 
601
        elif make_relative:
 
602
            url = urlutils.relative_url(self.base, url)
 
603
        config.set_user_option(name, url, warn_masked=True)
 
604
 
 
605
    def _get_config_location(self, name, config=None):
 
606
        if config is None:
 
607
            config = self.get_config()
 
608
        location = config.get_user_option(name)
 
609
        if location == '':
 
610
            location = None
 
611
        return location
 
612
 
 
613
    def get_submit_branch(self):
 
614
        """Return the submit location of the branch.
 
615
 
 
616
        This is the default location for bundle.  The usual
 
617
        pattern is that the user can override it by specifying a
 
618
        location.
 
619
        """
 
620
        return self.get_config().get_user_option('submit_branch')
 
621
 
 
622
    def set_submit_branch(self, location):
 
623
        """Return the submit location of the branch.
 
624
 
 
625
        This is the default location for bundle.  The usual
 
626
        pattern is that the user can override it by specifying a
 
627
        location.
 
628
        """
 
629
        self.get_config().set_user_option('submit_branch', location,
 
630
            warn_masked=True)
 
631
 
 
632
    def get_public_branch(self):
 
633
        """Return the public location of the branch.
 
634
 
 
635
        This is is used by merge directives.
 
636
        """
 
637
        return self._get_config_location('public_branch')
 
638
 
 
639
    def set_public_branch(self, location):
 
640
        """Return the submit location of the branch.
 
641
 
 
642
        This is the default location for bundle.  The usual
 
643
        pattern is that the user can override it by specifying a
 
644
        location.
 
645
        """
 
646
        self._set_config_location('public_branch', location)
 
647
 
 
648
    def get_push_location(self):
 
649
        """Return the None or the location to push this branch to."""
 
650
        push_loc = self.get_config().get_user_option('push_location')
 
651
        return push_loc
 
652
 
 
653
    def set_push_location(self, location):
 
654
        """Set a new push location for this branch."""
 
655
        raise NotImplementedError(self.set_push_location)
 
656
 
 
657
    def set_parent(self, url):
 
658
        raise NotImplementedError(self.set_parent)
 
659
 
 
660
    @needs_write_lock
 
661
    def update(self):
 
662
        """Synchronise this branch with the master branch if any. 
 
663
 
 
664
        :return: None or the last_revision pivoted out during the update.
 
665
        """
 
666
        return None
 
667
 
 
668
    def check_revno(self, revno):
 
669
        """\
 
670
        Check whether a revno corresponds to any revision.
 
671
        Zero (the NULL revision) is considered valid.
 
672
        """
 
673
        if revno != 0:
 
674
            self.check_real_revno(revno)
 
675
            
 
676
    def check_real_revno(self, revno):
 
677
        """\
 
678
        Check whether a revno corresponds to a real revision.
 
679
        Zero (the NULL revision) is considered invalid
 
680
        """
 
681
        if revno < 1 or revno > self.revno():
 
682
            raise errors.InvalidRevisionNumber(revno)
 
683
 
 
684
    @needs_read_lock
 
685
    def clone(self, to_bzrdir, revision_id=None):
 
686
        """Clone this branch into to_bzrdir preserving all semantic values.
 
687
        
 
688
        revision_id: if not None, the revision history in the new branch will
 
689
                     be truncated to end with revision_id.
 
690
        """
 
691
        result = to_bzrdir.create_branch()
 
692
        self.copy_content_into(result, revision_id=revision_id)
 
693
        return  result
 
694
 
 
695
    @needs_read_lock
 
696
    def sprout(self, to_bzrdir, revision_id=None):
 
697
        """Create a new line of development from the branch, into to_bzrdir.
 
698
 
 
699
        to_bzrdir controls the branch format.
 
700
 
 
701
        revision_id: if not None, the revision history in the new branch will
 
702
                     be truncated to end with revision_id.
 
703
        """
 
704
        result = to_bzrdir.create_branch()
 
705
        self.copy_content_into(result, revision_id=revision_id)
 
706
        result.set_parent(self.bzrdir.root_transport.base)
 
707
        return result
 
708
 
 
709
    def _synchronize_history(self, destination, revision_id):
 
710
        """Synchronize last revision and revision history between branches.
 
711
 
 
712
        This version is most efficient when the destination is also a
 
713
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
714
        history is the true lefthand parent history, and all of the revisions
 
715
        are in the destination's repository.  If not, set_revision_history
 
716
        will fail.
 
717
 
 
718
        :param destination: The branch to copy the history into
 
719
        :param revision_id: The revision-id to truncate history at.  May
 
720
          be None to copy complete history.
 
721
        """
 
722
        if revision_id == _mod_revision.NULL_REVISION:
 
723
            new_history = []
 
724
        else:
 
725
            new_history = self.revision_history()
 
726
        if revision_id is not None and new_history != []:
 
727
            try:
 
728
                new_history = new_history[:new_history.index(revision_id) + 1]
 
729
            except ValueError:
 
730
                rev = self.repository.get_revision(revision_id)
 
731
                new_history = rev.get_history(self.repository)[1:]
 
732
        destination.set_revision_history(new_history)
 
733
 
 
734
    @needs_read_lock
 
735
    def copy_content_into(self, destination, revision_id=None):
 
736
        """Copy the content of self into destination.
 
737
 
 
738
        revision_id: if not None, the revision history in the new branch will
 
739
                     be truncated to end with revision_id.
 
740
        """
 
741
        self._synchronize_history(destination, revision_id)
 
742
        try:
 
743
            parent = self.get_parent()
 
744
        except errors.InaccessibleParent, e:
 
745
            mutter('parent was not accessible to copy: %s', e)
 
746
        else:
 
747
            if parent:
 
748
                destination.set_parent(parent)
 
749
        self.tags.merge_to(destination.tags)
 
750
 
 
751
    @needs_read_lock
 
752
    def check(self):
 
753
        """Check consistency of the branch.
 
754
 
 
755
        In particular this checks that revisions given in the revision-history
 
756
        do actually match up in the revision graph, and that they're all 
 
757
        present in the repository.
 
758
        
 
759
        Callers will typically also want to check the repository.
 
760
 
 
761
        :return: A BranchCheckResult.
 
762
        """
 
763
        mainline_parent_id = None
 
764
        last_revno, last_revision_id = self.last_revision_info()
 
765
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
766
                                last_revision_id))
 
767
        real_rev_history.reverse()
 
768
        if len(real_rev_history) != last_revno:
 
769
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
770
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
771
        # TODO: We should probably also check that real_rev_history actually
 
772
        #       matches self.revision_history()
 
773
        for revision_id in real_rev_history:
 
774
            try:
 
775
                revision = self.repository.get_revision(revision_id)
 
776
            except errors.NoSuchRevision, e:
 
777
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
778
                            % revision_id)
 
779
            # In general the first entry on the revision history has no parents.
 
780
            # But it's not illegal for it to have parents listed; this can happen
 
781
            # in imports from Arch when the parents weren't reachable.
 
782
            if mainline_parent_id is not None:
 
783
                if mainline_parent_id not in revision.parent_ids:
 
784
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
785
                                        "parents of {%s}"
 
786
                                        % (mainline_parent_id, revision_id))
 
787
            mainline_parent_id = revision_id
 
788
        return BranchCheckResult(self)
 
789
 
 
790
    def _get_checkout_format(self):
 
791
        """Return the most suitable metadir for a checkout of this branch.
 
792
        Weaves are used if this branch's repository uses weaves.
 
793
        """
 
794
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
795
            from bzrlib.repofmt import weaverepo
 
796
            format = bzrdir.BzrDirMetaFormat1()
 
797
            format.repository_format = weaverepo.RepositoryFormat7()
 
798
        else:
 
799
            format = self.repository.bzrdir.checkout_metadir()
 
800
            format.set_branch_format(self._format)
 
801
        return format
 
802
 
 
803
    def create_checkout(self, to_location, revision_id=None,
 
804
                        lightweight=False, accelerator_tree=None,
 
805
                        hardlink=False):
 
806
        """Create a checkout of a branch.
 
807
        
 
808
        :param to_location: The url to produce the checkout at
 
809
        :param revision_id: The revision to check out
 
810
        :param lightweight: If True, produce a lightweight checkout, otherwise,
 
811
        produce a bound branch (heavyweight checkout)
 
812
        :param accelerator_tree: A tree which can be used for retrieving file
 
813
            contents more quickly than the revision tree, i.e. a workingtree.
 
814
            The revision tree will be used for cases where accelerator_tree's
 
815
            content is different.
 
816
        :param hardlink: If true, hard-link files from accelerator_tree,
 
817
            where possible.
 
818
        :return: The tree of the created checkout
 
819
        """
 
820
        t = transport.get_transport(to_location)
 
821
        t.ensure_base()
 
822
        if lightweight:
 
823
            format = self._get_checkout_format()
 
824
            checkout = format.initialize_on_transport(t)
 
825
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
826
        else:
 
827
            format = self._get_checkout_format()
 
828
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
829
                to_location, force_new_tree=False, format=format)
 
830
            checkout = checkout_branch.bzrdir
 
831
            checkout_branch.bind(self)
 
832
            # pull up to the specified revision_id to set the initial 
 
833
            # branch tip correctly, and seed it with history.
 
834
            checkout_branch.pull(self, stop_revision=revision_id)
 
835
            from_branch=None
 
836
        tree = checkout.create_workingtree(revision_id,
 
837
                                           from_branch=from_branch,
 
838
                                           accelerator_tree=accelerator_tree,
 
839
                                           hardlink=hardlink)
 
840
        basis_tree = tree.basis_tree()
 
841
        basis_tree.lock_read()
 
842
        try:
 
843
            for path, file_id in basis_tree.iter_references():
 
844
                reference_parent = self.reference_parent(file_id, path)
 
845
                reference_parent.create_checkout(tree.abspath(path),
 
846
                    basis_tree.get_reference_revision(file_id, path),
 
847
                    lightweight)
 
848
        finally:
 
849
            basis_tree.unlock()
 
850
        return tree
 
851
 
 
852
    @needs_write_lock
 
853
    def reconcile(self, thorough=True):
 
854
        """Make sure the data stored in this branch is consistent."""
 
855
        from bzrlib.reconcile import BranchReconciler
 
856
        reconciler = BranchReconciler(self, thorough=thorough)
 
857
        reconciler.reconcile()
 
858
        return reconciler
 
859
 
 
860
    def reference_parent(self, file_id, path):
 
861
        """Return the parent branch for a tree-reference file_id
 
862
        :param file_id: The file_id of the tree reference
 
863
        :param path: The path of the file_id in the tree
 
864
        :return: A branch associated with the file_id
 
865
        """
 
866
        # FIXME should provide multiple branches, based on config
 
867
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
 
868
 
 
869
    def supports_tags(self):
 
870
        return self._format.supports_tags()
 
871
 
 
872
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
 
873
                                         other_branch):
 
874
        """Ensure that revision_b is a descendant of revision_a.
 
875
 
 
876
        This is a helper function for update_revisions.
 
877
        
 
878
        :raises: DivergedBranches if revision_b has diverged from revision_a.
 
879
        :returns: True if revision_b is a descendant of revision_a.
 
880
        """
 
881
        relation = self._revision_relations(revision_a, revision_b, graph)
 
882
        if relation == 'b_descends_from_a':
 
883
            return True
 
884
        elif relation == 'diverged':
 
885
            raise errors.DivergedBranches(self, other_branch)
 
886
        elif relation == 'a_descends_from_b':
 
887
            return False
 
888
        else:
 
889
            raise AssertionError("invalid relation: %r" % (relation,))
 
890
 
 
891
    def _revision_relations(self, revision_a, revision_b, graph):
 
892
        """Determine the relationship between two revisions.
 
893
        
 
894
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
 
895
        """
 
896
        heads = graph.heads([revision_a, revision_b])
 
897
        if heads == set([revision_b]):
 
898
            return 'b_descends_from_a'
 
899
        elif heads == set([revision_a, revision_b]):
 
900
            # These branches have diverged
 
901
            return 'diverged'
 
902
        elif heads == set([revision_a]):
 
903
            return 'a_descends_from_b'
 
904
        else:
 
905
            raise AssertionError("invalid heads: %r" % (heads,))
 
906
 
 
907
 
 
908
class BranchFormat(object):
 
909
    """An encapsulation of the initialization and open routines for a format.
 
910
 
 
911
    Formats provide three things:
 
912
     * An initialization routine,
 
913
     * a format string,
 
914
     * an open routine.
 
915
 
 
916
    Formats are placed in an dict by their format string for reference 
 
917
    during branch opening. Its not required that these be instances, they
 
918
    can be classes themselves with class methods - it simply depends on 
 
919
    whether state is needed for a given format or not.
 
920
 
 
921
    Once a format is deprecated, just deprecate the initialize and open
 
922
    methods on the format class. Do not deprecate the object, as the 
 
923
    object will be created every time regardless.
 
924
    """
 
925
 
 
926
    _default_format = None
 
927
    """The default format used for new branches."""
 
928
 
 
929
    _formats = {}
 
930
    """The known formats."""
 
931
 
 
932
    def __eq__(self, other):
 
933
        return self.__class__ is other.__class__
 
934
 
 
935
    def __ne__(self, other):
 
936
        return not (self == other)
 
937
 
 
938
    @classmethod
 
939
    def find_format(klass, a_bzrdir):
 
940
        """Return the format for the branch object in a_bzrdir."""
 
941
        try:
 
942
            transport = a_bzrdir.get_branch_transport(None)
 
943
            format_string = transport.get("format").read()
 
944
            return klass._formats[format_string]
 
945
        except errors.NoSuchFile:
 
946
            raise errors.NotBranchError(path=transport.base)
 
947
        except KeyError:
 
948
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
949
 
 
950
    @classmethod
 
951
    def get_default_format(klass):
 
952
        """Return the current default format."""
 
953
        return klass._default_format
 
954
 
 
955
    def get_reference(self, a_bzrdir):
 
956
        """Get the target reference of the branch in a_bzrdir.
 
957
 
 
958
        format probing must have been completed before calling
 
959
        this method - it is assumed that the format of the branch
 
960
        in a_bzrdir is correct.
 
961
 
 
962
        :param a_bzrdir: The bzrdir to get the branch data from.
 
963
        :return: None if the branch is not a reference branch.
 
964
        """
 
965
        return None
 
966
 
 
967
    @classmethod
 
968
    def set_reference(self, a_bzrdir, to_branch):
 
969
        """Set the target reference of the branch in a_bzrdir.
 
970
 
 
971
        format probing must have been completed before calling
 
972
        this method - it is assumed that the format of the branch
 
973
        in a_bzrdir is correct.
 
974
 
 
975
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
976
        :param to_branch: branch that the checkout is to reference
 
977
        """
 
978
        raise NotImplementedError(self.set_reference)
 
979
 
 
980
    def get_format_string(self):
 
981
        """Return the ASCII format string that identifies this format."""
 
982
        raise NotImplementedError(self.get_format_string)
 
983
 
 
984
    def get_format_description(self):
 
985
        """Return the short format description for this format."""
 
986
        raise NotImplementedError(self.get_format_description)
 
987
 
 
988
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
989
                           set_format=True):
 
990
        """Initialize a branch in a bzrdir, with specified files
 
991
 
 
992
        :param a_bzrdir: The bzrdir to initialize the branch in
 
993
        :param utf8_files: The files to create as a list of
 
994
            (filename, content) tuples
 
995
        :param set_format: If True, set the format with
 
996
            self.get_format_string.  (BzrBranch4 has its format set
 
997
            elsewhere)
 
998
        :return: a branch in this format
 
999
        """
 
1000
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1001
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1002
        lock_map = {
 
1003
            'metadir': ('lock', lockdir.LockDir),
 
1004
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1005
        }
 
1006
        lock_name, lock_class = lock_map[lock_type]
 
1007
        control_files = lockable_files.LockableFiles(branch_transport,
 
1008
            lock_name, lock_class)
 
1009
        control_files.create_lock()
 
1010
        control_files.lock_write()
 
1011
        if set_format:
 
1012
            utf8_files += [('format', self.get_format_string())]
 
1013
        try:
 
1014
            for (filename, content) in utf8_files:
 
1015
                branch_transport.put_bytes(
 
1016
                    filename, content,
 
1017
                    mode=a_bzrdir._get_file_mode())
 
1018
        finally:
 
1019
            control_files.unlock()
 
1020
        return self.open(a_bzrdir, _found=True)
 
1021
 
 
1022
    def initialize(self, a_bzrdir):
 
1023
        """Create a branch of this format in a_bzrdir."""
 
1024
        raise NotImplementedError(self.initialize)
 
1025
 
 
1026
    def is_supported(self):
 
1027
        """Is this format supported?
 
1028
 
 
1029
        Supported formats can be initialized and opened.
 
1030
        Unsupported formats may not support initialization or committing or 
 
1031
        some other features depending on the reason for not being supported.
 
1032
        """
 
1033
        return True
 
1034
 
 
1035
    def open(self, a_bzrdir, _found=False):
 
1036
        """Return the branch object for a_bzrdir
 
1037
 
 
1038
        _found is a private parameter, do not use it. It is used to indicate
 
1039
               if format probing has already be done.
 
1040
        """
 
1041
        raise NotImplementedError(self.open)
 
1042
 
 
1043
    @classmethod
 
1044
    def register_format(klass, format):
 
1045
        klass._formats[format.get_format_string()] = format
 
1046
 
 
1047
    @classmethod
 
1048
    def set_default_format(klass, format):
 
1049
        klass._default_format = format
 
1050
 
 
1051
    def supports_stacking(self):
 
1052
        """True if this format records a stacked-on branch."""
 
1053
        return False
 
1054
 
 
1055
    @classmethod
 
1056
    def unregister_format(klass, format):
 
1057
        del klass._formats[format.get_format_string()]
 
1058
 
 
1059
    def __str__(self):
 
1060
        return self.get_format_string().rstrip()
 
1061
 
 
1062
    def supports_tags(self):
 
1063
        """True if this format supports tags stored in the branch"""
 
1064
        return False  # by default
 
1065
 
 
1066
 
 
1067
class BranchHooks(Hooks):
 
1068
    """A dictionary mapping hook name to a list of callables for branch hooks.
 
1069
    
 
1070
    e.g. ['set_rh'] Is the list of items to be called when the
 
1071
    set_revision_history function is invoked.
 
1072
    """
 
1073
 
 
1074
    def __init__(self):
 
1075
        """Create the default hooks.
 
1076
 
 
1077
        These are all empty initially, because by default nothing should get
 
1078
        notified.
 
1079
        """
 
1080
        Hooks.__init__(self)
 
1081
        # Introduced in 0.15:
 
1082
        # invoked whenever the revision history has been set
 
1083
        # with set_revision_history. The api signature is
 
1084
        # (branch, revision_history), and the branch will
 
1085
        # be write-locked.
 
1086
        self['set_rh'] = []
 
1087
        # Invoked after a branch is opened. The api signature is (branch).
 
1088
        self['open'] = []
 
1089
        # invoked after a push operation completes.
 
1090
        # the api signature is
 
1091
        # (push_result)
 
1092
        # containing the members
 
1093
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1094
        # where local is the local target branch or None, master is the target 
 
1095
        # master branch, and the rest should be self explanatory. The source
 
1096
        # is read locked and the target branches write locked. Source will
 
1097
        # be the local low-latency branch.
 
1098
        self['post_push'] = []
 
1099
        # invoked after a pull operation completes.
 
1100
        # the api signature is
 
1101
        # (pull_result)
 
1102
        # containing the members
 
1103
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1104
        # where local is the local branch or None, master is the target 
 
1105
        # master branch, and the rest should be self explanatory. The source
 
1106
        # is read locked and the target branches write locked. The local
 
1107
        # branch is the low-latency branch.
 
1108
        self['post_pull'] = []
 
1109
        # invoked before a commit operation takes place.
 
1110
        # the api signature is
 
1111
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1112
        #  tree_delta, future_tree).
 
1113
        # old_revid is NULL_REVISION for the first commit to a branch
 
1114
        # tree_delta is a TreeDelta object describing changes from the basis
 
1115
        # revision, hooks MUST NOT modify this delta
 
1116
        # future_tree is an in-memory tree obtained from
 
1117
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1118
        self['pre_commit'] = []
 
1119
        # invoked after a commit operation completes.
 
1120
        # the api signature is 
 
1121
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1122
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1123
        self['post_commit'] = []
 
1124
        # invoked after a uncommit operation completes.
 
1125
        # the api signature is
 
1126
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1127
        # local is the local branch or None, master is the target branch,
 
1128
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1129
        self['post_uncommit'] = []
 
1130
        # Introduced in 1.6
 
1131
        # Invoked before the tip of a branch changes.
 
1132
        # the api signature is
 
1133
        # (params) where params is a ChangeBranchTipParams with the members
 
1134
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1135
        self['pre_change_branch_tip'] = []
 
1136
        # Introduced in 1.4
 
1137
        # Invoked after the tip of a branch changes.
 
1138
        # the api signature is
 
1139
        # (params) where params is a ChangeBranchTipParams with the members
 
1140
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1141
        self['post_change_branch_tip'] = []
 
1142
        # Introduced in 1.9
 
1143
        # Invoked when a stacked branch activates its fallback locations and
 
1144
        # allows the transformation of the url of said location.
 
1145
        # the api signature is
 
1146
        # (branch, url) where branch is the branch having its fallback
 
1147
        # location activated and url is the url for the fallback location.
 
1148
        # The hook should return a url.
 
1149
        self['transform_fallback_location'] = []
 
1150
 
 
1151
 
 
1152
# install the default hooks into the Branch class.
 
1153
Branch.hooks = BranchHooks()
 
1154
 
 
1155
 
 
1156
class ChangeBranchTipParams(object):
 
1157
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1158
 
 
1159
    There are 5 fields that hooks may wish to access:
 
1160
 
 
1161
    :ivar branch: the branch being changed
 
1162
    :ivar old_revno: revision number before the change
 
1163
    :ivar new_revno: revision number after the change
 
1164
    :ivar old_revid: revision id before the change
 
1165
    :ivar new_revid: revision id after the change
 
1166
 
 
1167
    The revid fields are strings. The revno fields are integers.
 
1168
    """
 
1169
 
 
1170
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
 
1171
        """Create a group of ChangeBranchTip parameters.
 
1172
 
 
1173
        :param branch: The branch being changed.
 
1174
        :param old_revno: Revision number before the change.
 
1175
        :param new_revno: Revision number after the change.
 
1176
        :param old_revid: Tip revision id before the change.
 
1177
        :param new_revid: Tip revision id after the change.
 
1178
        """
 
1179
        self.branch = branch
 
1180
        self.old_revno = old_revno
 
1181
        self.new_revno = new_revno
 
1182
        self.old_revid = old_revid
 
1183
        self.new_revid = new_revid
 
1184
 
 
1185
    def __eq__(self, other):
 
1186
        return self.__dict__ == other.__dict__
 
1187
    
 
1188
    def __repr__(self):
 
1189
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
 
1190
            self.__class__.__name__, self.branch, 
 
1191
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
 
1192
 
 
1193
 
 
1194
class BzrBranchFormat4(BranchFormat):
 
1195
    """Bzr branch format 4.
 
1196
 
 
1197
    This format has:
 
1198
     - a revision-history file.
 
1199
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1200
    """
 
1201
 
 
1202
    def get_format_description(self):
 
1203
        """See BranchFormat.get_format_description()."""
 
1204
        return "Branch format 4"
 
1205
 
 
1206
    def initialize(self, a_bzrdir):
 
1207
        """Create a branch of this format in a_bzrdir."""
 
1208
        utf8_files = [('revision-history', ''),
 
1209
                      ('branch-name', ''),
 
1210
                      ]
 
1211
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1212
                                       lock_type='branch4', set_format=False)
 
1213
 
 
1214
    def __init__(self):
 
1215
        super(BzrBranchFormat4, self).__init__()
 
1216
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1217
 
 
1218
    def open(self, a_bzrdir, _found=False):
 
1219
        """Return the branch object for a_bzrdir
 
1220
 
 
1221
        _found is a private parameter, do not use it. It is used to indicate
 
1222
               if format probing has already be done.
 
1223
        """
 
1224
        if not _found:
 
1225
            # we are being called directly and must probe.
 
1226
            raise NotImplementedError
 
1227
        return BzrBranch(_format=self,
 
1228
                         _control_files=a_bzrdir._control_files,
 
1229
                         a_bzrdir=a_bzrdir,
 
1230
                         _repository=a_bzrdir.open_repository())
 
1231
 
 
1232
    def __str__(self):
 
1233
        return "Bazaar-NG branch format 4"
 
1234
 
 
1235
 
 
1236
class BranchFormatMetadir(BranchFormat):
 
1237
    """Common logic for meta-dir based branch formats."""
 
1238
 
 
1239
    def _branch_class(self):
 
1240
        """What class to instantiate on open calls."""
 
1241
        raise NotImplementedError(self._branch_class)
 
1242
 
 
1243
    def open(self, a_bzrdir, _found=False):
 
1244
        """Return the branch object for a_bzrdir.
 
1245
 
 
1246
        _found is a private parameter, do not use it. It is used to indicate
 
1247
               if format probing has already be done.
 
1248
        """
 
1249
        if not _found:
 
1250
            format = BranchFormat.find_format(a_bzrdir)
 
1251
            if format.__class__ != self.__class__:
 
1252
                raise AssertionError("wrong format %r found for %r" %
 
1253
                    (format, self))
 
1254
        try:
 
1255
            transport = a_bzrdir.get_branch_transport(None)
 
1256
            control_files = lockable_files.LockableFiles(transport, 'lock',
 
1257
                                                         lockdir.LockDir)
 
1258
            return self._branch_class()(_format=self,
 
1259
                              _control_files=control_files,
 
1260
                              a_bzrdir=a_bzrdir,
 
1261
                              _repository=a_bzrdir.find_repository())
 
1262
        except errors.NoSuchFile:
 
1263
            raise errors.NotBranchError(path=transport.base)
 
1264
 
 
1265
    def __init__(self):
 
1266
        super(BranchFormatMetadir, self).__init__()
 
1267
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1268
 
 
1269
    def supports_tags(self):
 
1270
        return True
 
1271
 
 
1272
 
 
1273
class BzrBranchFormat5(BranchFormatMetadir):
 
1274
    """Bzr branch format 5.
 
1275
 
 
1276
    This format has:
 
1277
     - a revision-history file.
 
1278
     - a format string
 
1279
     - a lock dir guarding the branch itself
 
1280
     - all of this stored in a branch/ subdirectory
 
1281
     - works with shared repositories.
 
1282
 
 
1283
    This format is new in bzr 0.8.
 
1284
    """
 
1285
 
 
1286
    def _branch_class(self):
 
1287
        return BzrBranch5
 
1288
 
 
1289
    def get_format_string(self):
 
1290
        """See BranchFormat.get_format_string()."""
 
1291
        return "Bazaar-NG branch format 5\n"
 
1292
 
 
1293
    def get_format_description(self):
 
1294
        """See BranchFormat.get_format_description()."""
 
1295
        return "Branch format 5"
 
1296
        
 
1297
    def initialize(self, a_bzrdir):
 
1298
        """Create a branch of this format in a_bzrdir."""
 
1299
        utf8_files = [('revision-history', ''),
 
1300
                      ('branch-name', ''),
 
1301
                      ]
 
1302
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1303
 
 
1304
    def supports_tags(self):
 
1305
        return False
 
1306
 
 
1307
 
 
1308
class BzrBranchFormat6(BranchFormatMetadir):
 
1309
    """Branch format with last-revision and tags.
 
1310
 
 
1311
    Unlike previous formats, this has no explicit revision history. Instead,
 
1312
    this just stores the last-revision, and the left-hand history leading
 
1313
    up to there is the history.
 
1314
 
 
1315
    This format was introduced in bzr 0.15
 
1316
    and became the default in 0.91.
 
1317
    """
 
1318
 
 
1319
    def _branch_class(self):
 
1320
        return BzrBranch6
 
1321
 
 
1322
    def get_format_string(self):
 
1323
        """See BranchFormat.get_format_string()."""
 
1324
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
 
1325
 
 
1326
    def get_format_description(self):
 
1327
        """See BranchFormat.get_format_description()."""
 
1328
        return "Branch format 6"
 
1329
 
 
1330
    def initialize(self, a_bzrdir):
 
1331
        """Create a branch of this format in a_bzrdir."""
 
1332
        utf8_files = [('last-revision', '0 null:\n'),
 
1333
                      ('branch.conf', ''),
 
1334
                      ('tags', ''),
 
1335
                      ]
 
1336
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1337
 
 
1338
 
 
1339
class BzrBranchFormat7(BranchFormatMetadir):
 
1340
    """Branch format with last-revision, tags, and a stacked location pointer.
 
1341
 
 
1342
    The stacked location pointer is passed down to the repository and requires
 
1343
    a repository format with supports_external_lookups = True.
 
1344
 
 
1345
    This format was introduced in bzr 1.6.
 
1346
    """
 
1347
 
 
1348
    def _branch_class(self):
 
1349
        return BzrBranch7
 
1350
 
 
1351
    def get_format_string(self):
 
1352
        """See BranchFormat.get_format_string()."""
 
1353
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
 
1354
 
 
1355
    def get_format_description(self):
 
1356
        """See BranchFormat.get_format_description()."""
 
1357
        return "Branch format 7"
 
1358
 
 
1359
    def initialize(self, a_bzrdir):
 
1360
        """Create a branch of this format in a_bzrdir."""
 
1361
        utf8_files = [('last-revision', '0 null:\n'),
 
1362
                      ('branch.conf', ''),
 
1363
                      ('tags', ''),
 
1364
                      ]
 
1365
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1366
 
 
1367
    def __init__(self):
 
1368
        super(BzrBranchFormat7, self).__init__()
 
1369
        self._matchingbzrdir.repository_format = \
 
1370
            RepositoryFormatKnitPack5RichRoot()
 
1371
 
 
1372
    def supports_stacking(self):
 
1373
        return True
 
1374
 
 
1375
 
 
1376
class BranchReferenceFormat(BranchFormat):
 
1377
    """Bzr branch reference format.
 
1378
 
 
1379
    Branch references are used in implementing checkouts, they
 
1380
    act as an alias to the real branch which is at some other url.
 
1381
 
 
1382
    This format has:
 
1383
     - A location file
 
1384
     - a format string
 
1385
    """
 
1386
 
 
1387
    def get_format_string(self):
 
1388
        """See BranchFormat.get_format_string()."""
 
1389
        return "Bazaar-NG Branch Reference Format 1\n"
 
1390
 
 
1391
    def get_format_description(self):
 
1392
        """See BranchFormat.get_format_description()."""
 
1393
        return "Checkout reference format 1"
 
1394
 
 
1395
    def get_reference(self, a_bzrdir):
 
1396
        """See BranchFormat.get_reference()."""
 
1397
        transport = a_bzrdir.get_branch_transport(None)
 
1398
        return transport.get('location').read()
 
1399
 
 
1400
    def set_reference(self, a_bzrdir, to_branch):
 
1401
        """See BranchFormat.set_reference()."""
 
1402
        transport = a_bzrdir.get_branch_transport(None)
 
1403
        location = transport.put_bytes('location', to_branch.base)
 
1404
 
 
1405
    def initialize(self, a_bzrdir, target_branch=None):
 
1406
        """Create a branch of this format in a_bzrdir."""
 
1407
        if target_branch is None:
 
1408
            # this format does not implement branch itself, thus the implicit
 
1409
            # creation contract must see it as uninitializable
 
1410
            raise errors.UninitializableFormat(self)
 
1411
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1412
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1413
        branch_transport.put_bytes('location',
 
1414
            target_branch.bzrdir.root_transport.base)
 
1415
        branch_transport.put_bytes('format', self.get_format_string())
 
1416
        return self.open(
 
1417
            a_bzrdir, _found=True,
 
1418
            possible_transports=[target_branch.bzrdir.root_transport])
 
1419
 
 
1420
    def __init__(self):
 
1421
        super(BranchReferenceFormat, self).__init__()
 
1422
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1423
 
 
1424
    def _make_reference_clone_function(format, a_branch):
 
1425
        """Create a clone() routine for a branch dynamically."""
 
1426
        def clone(to_bzrdir, revision_id=None):
 
1427
            """See Branch.clone()."""
 
1428
            return format.initialize(to_bzrdir, a_branch)
 
1429
            # cannot obey revision_id limits when cloning a reference ...
 
1430
            # FIXME RBC 20060210 either nuke revision_id for clone, or
 
1431
            # emit some sort of warning/error to the caller ?!
 
1432
        return clone
 
1433
 
 
1434
    def open(self, a_bzrdir, _found=False, location=None,
 
1435
             possible_transports=None):
 
1436
        """Return the branch that the branch reference in a_bzrdir points at.
 
1437
 
 
1438
        _found is a private parameter, do not use it. It is used to indicate
 
1439
               if format probing has already be done.
 
1440
        """
 
1441
        if not _found:
 
1442
            format = BranchFormat.find_format(a_bzrdir)
 
1443
            if format.__class__ != self.__class__:
 
1444
                raise AssertionError("wrong format %r found for %r" %
 
1445
                    (format, self))
 
1446
        if location is None:
 
1447
            location = self.get_reference(a_bzrdir)
 
1448
        real_bzrdir = bzrdir.BzrDir.open(
 
1449
            location, possible_transports=possible_transports)
 
1450
        result = real_bzrdir.open_branch()
 
1451
        # this changes the behaviour of result.clone to create a new reference
 
1452
        # rather than a copy of the content of the branch.
 
1453
        # I did not use a proxy object because that needs much more extensive
 
1454
        # testing, and we are only changing one behaviour at the moment.
 
1455
        # If we decide to alter more behaviours - i.e. the implicit nickname
 
1456
        # then this should be refactored to introduce a tested proxy branch
 
1457
        # and a subclass of that for use in overriding clone() and ....
 
1458
        # - RBC 20060210
 
1459
        result.clone = self._make_reference_clone_function(result)
 
1460
        return result
 
1461
 
 
1462
 
 
1463
# formats which have no format string are not discoverable
 
1464
# and not independently creatable, so are not registered.
 
1465
__format5 = BzrBranchFormat5()
 
1466
__format6 = BzrBranchFormat6()
 
1467
__format7 = BzrBranchFormat7()
 
1468
BranchFormat.register_format(__format5)
 
1469
BranchFormat.register_format(BranchReferenceFormat())
 
1470
BranchFormat.register_format(__format6)
 
1471
BranchFormat.register_format(__format7)
 
1472
BranchFormat.set_default_format(__format6)
 
1473
_legacy_formats = [BzrBranchFormat4(),
 
1474
                   ]
 
1475
 
 
1476
class BzrBranch(Branch):
 
1477
    """A branch stored in the actual filesystem.
 
1478
 
 
1479
    Note that it's "local" in the context of the filesystem; it doesn't
 
1480
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
1481
    it's writable, and can be accessed via the normal filesystem API.
 
1482
 
 
1483
    :ivar _transport: Transport for file operations on this branch's 
 
1484
        control files, typically pointing to the .bzr/branch directory.
 
1485
    :ivar repository: Repository for this branch.
 
1486
    :ivar base: The url of the base directory for this branch; the one 
 
1487
        containing the .bzr directory.
 
1488
    """
 
1489
    
 
1490
    def __init__(self, _format=None,
 
1491
                 _control_files=None, a_bzrdir=None, _repository=None):
 
1492
        """Create new branch object at a particular location."""
 
1493
        if a_bzrdir is None:
 
1494
            raise ValueError('a_bzrdir must be supplied')
 
1495
        else:
 
1496
            self.bzrdir = a_bzrdir
 
1497
        self._base = self.bzrdir.transport.clone('..').base
 
1498
        # XXX: We should be able to just do
 
1499
        #   self.base = self.bzrdir.root_transport.base
 
1500
        # but this does not quite work yet -- mbp 20080522
 
1501
        self._format = _format
 
1502
        if _control_files is None:
 
1503
            raise ValueError('BzrBranch _control_files is None')
 
1504
        self.control_files = _control_files
 
1505
        self._transport = _control_files._transport
 
1506
        self.repository = _repository
 
1507
        Branch.__init__(self)
 
1508
 
 
1509
    def __str__(self):
 
1510
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
1511
 
 
1512
    __repr__ = __str__
 
1513
 
 
1514
    def _get_base(self):
 
1515
        """Returns the directory containing the control directory."""
 
1516
        return self._base
 
1517
 
 
1518
    base = property(_get_base, doc="The URL for the root of this branch.")
 
1519
 
 
1520
    def is_locked(self):
 
1521
        return self.control_files.is_locked()
 
1522
 
 
1523
    def lock_write(self, token=None):
 
1524
        repo_token = self.repository.lock_write()
 
1525
        try:
 
1526
            token = self.control_files.lock_write(token=token)
 
1527
        except:
 
1528
            self.repository.unlock()
 
1529
            raise
 
1530
        return token
 
1531
 
 
1532
    def lock_read(self):
 
1533
        self.repository.lock_read()
 
1534
        try:
 
1535
            self.control_files.lock_read()
 
1536
        except:
 
1537
            self.repository.unlock()
 
1538
            raise
 
1539
 
 
1540
    def unlock(self):
 
1541
        # TODO: test for failed two phase locks. This is known broken.
 
1542
        try:
 
1543
            self.control_files.unlock()
 
1544
        finally:
 
1545
            self.repository.unlock()
 
1546
        if not self.control_files.is_locked():
 
1547
            # we just released the lock
 
1548
            self._clear_cached_state()
 
1549
        
 
1550
    def peek_lock_mode(self):
 
1551
        if self.control_files._lock_count == 0:
 
1552
            return None
 
1553
        else:
 
1554
            return self.control_files._lock_mode
 
1555
 
 
1556
    def get_physical_lock_status(self):
 
1557
        return self.control_files.get_physical_lock_status()
 
1558
 
 
1559
    @needs_read_lock
 
1560
    def print_file(self, file, revision_id):
 
1561
        """See Branch.print_file."""
 
1562
        return self.repository.print_file(file, revision_id)
 
1563
 
 
1564
    def _write_revision_history(self, history):
 
1565
        """Factored out of set_revision_history.
 
1566
 
 
1567
        This performs the actual writing to disk.
 
1568
        It is intended to be called by BzrBranch5.set_revision_history."""
 
1569
        self._transport.put_bytes(
 
1570
            'revision-history', '\n'.join(history),
 
1571
            mode=self.bzrdir._get_file_mode())
 
1572
 
 
1573
    @needs_write_lock
 
1574
    def set_revision_history(self, rev_history):
 
1575
        """See Branch.set_revision_history."""
 
1576
        if 'evil' in debug.debug_flags:
 
1577
            mutter_callsite(3, "set_revision_history scales with history.")
 
1578
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
1579
        for rev_id in rev_history:
 
1580
            check_not_reserved_id(rev_id)
 
1581
        if Branch.hooks['post_change_branch_tip']:
 
1582
            # Don't calculate the last_revision_info() if there are no hooks
 
1583
            # that will use it.
 
1584
            old_revno, old_revid = self.last_revision_info()
 
1585
        if len(rev_history) == 0:
 
1586
            revid = _mod_revision.NULL_REVISION
 
1587
        else:
 
1588
            revid = rev_history[-1]
 
1589
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
1590
        self._write_revision_history(rev_history)
 
1591
        self._clear_cached_state()
 
1592
        self._cache_revision_history(rev_history)
 
1593
        for hook in Branch.hooks['set_rh']:
 
1594
            hook(self, rev_history)
 
1595
        if Branch.hooks['post_change_branch_tip']:
 
1596
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
1597
 
 
1598
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1599
        """Run the pre_change_branch_tip hooks."""
 
1600
        hooks = Branch.hooks['pre_change_branch_tip']
 
1601
        if not hooks:
 
1602
            return
 
1603
        old_revno, old_revid = self.last_revision_info()
 
1604
        params = ChangeBranchTipParams(
 
1605
            self, old_revno, new_revno, old_revid, new_revid)
 
1606
        for hook in hooks:
 
1607
            try:
 
1608
                hook(params)
 
1609
            except errors.TipChangeRejected:
 
1610
                raise
 
1611
            except Exception:
 
1612
                exc_info = sys.exc_info()
 
1613
                hook_name = Branch.hooks.get_hook_name(hook)
 
1614
                raise errors.HookFailed(
 
1615
                    'pre_change_branch_tip', hook_name, exc_info)
 
1616
 
 
1617
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1618
        """Run the post_change_branch_tip hooks."""
 
1619
        hooks = Branch.hooks['post_change_branch_tip']
 
1620
        if not hooks:
 
1621
            return
 
1622
        new_revno, new_revid = self.last_revision_info()
 
1623
        params = ChangeBranchTipParams(
 
1624
            self, old_revno, new_revno, old_revid, new_revid)
 
1625
        for hook in hooks:
 
1626
            hook(params)
 
1627
 
 
1628
    @needs_write_lock
 
1629
    def set_last_revision_info(self, revno, revision_id):
 
1630
        """Set the last revision of this branch.
 
1631
 
 
1632
        The caller is responsible for checking that the revno is correct
 
1633
        for this revision id.
 
1634
 
 
1635
        It may be possible to set the branch last revision to an id not
 
1636
        present in the repository.  However, branches can also be 
 
1637
        configured to check constraints on history, in which case this may not
 
1638
        be permitted.
 
1639
        """
 
1640
        revision_id = _mod_revision.ensure_null(revision_id)
 
1641
        # this old format stores the full history, but this api doesn't
 
1642
        # provide it, so we must generate, and might as well check it's
 
1643
        # correct
 
1644
        history = self._lefthand_history(revision_id)
 
1645
        if len(history) != revno:
 
1646
            raise AssertionError('%d != %d' % (len(history), revno))
 
1647
        self.set_revision_history(history)
 
1648
 
 
1649
    def _gen_revision_history(self):
 
1650
        history = self._transport.get_bytes('revision-history').split('\n')
 
1651
        if history[-1:] == ['']:
 
1652
            # There shouldn't be a trailing newline, but just in case.
 
1653
            history.pop()
 
1654
        return history
 
1655
 
 
1656
    def _lefthand_history(self, revision_id, last_rev=None,
 
1657
                          other_branch=None):
 
1658
        if 'evil' in debug.debug_flags:
 
1659
            mutter_callsite(4, "_lefthand_history scales with history.")
 
1660
        # stop_revision must be a descendant of last_revision
 
1661
        graph = self.repository.get_graph()
 
1662
        if last_rev is not None:
 
1663
            if not graph.is_ancestor(last_rev, revision_id):
 
1664
                # our previous tip is not merged into stop_revision
 
1665
                raise errors.DivergedBranches(self, other_branch)
 
1666
        # make a new revision history from the graph
 
1667
        parents_map = graph.get_parent_map([revision_id])
 
1668
        if revision_id not in parents_map:
 
1669
            raise errors.NoSuchRevision(self, revision_id)
 
1670
        current_rev_id = revision_id
 
1671
        new_history = []
 
1672
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
1673
        # Do not include ghosts or graph origin in revision_history
 
1674
        while (current_rev_id in parents_map and
 
1675
               len(parents_map[current_rev_id]) > 0):
 
1676
            check_not_reserved_id(current_rev_id)
 
1677
            new_history.append(current_rev_id)
 
1678
            current_rev_id = parents_map[current_rev_id][0]
 
1679
            parents_map = graph.get_parent_map([current_rev_id])
 
1680
        new_history.reverse()
 
1681
        return new_history
 
1682
 
 
1683
    @needs_write_lock
 
1684
    def generate_revision_history(self, revision_id, last_rev=None,
 
1685
        other_branch=None):
 
1686
        """Create a new revision history that will finish with revision_id.
 
1687
 
 
1688
        :param revision_id: the new tip to use.
 
1689
        :param last_rev: The previous last_revision. If not None, then this
 
1690
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
1691
        :param other_branch: The other branch that DivergedBranches should
 
1692
            raise with respect to.
 
1693
        """
 
1694
        self.set_revision_history(self._lefthand_history(revision_id,
 
1695
            last_rev, other_branch))
 
1696
 
 
1697
    def basis_tree(self):
 
1698
        """See Branch.basis_tree."""
 
1699
        return self.repository.revision_tree(self.last_revision())
 
1700
 
 
1701
    @needs_write_lock
 
1702
    def pull(self, source, overwrite=False, stop_revision=None,
 
1703
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1704
             _override_hook_target=None):
 
1705
        """See Branch.pull.
 
1706
 
 
1707
        :param _hook_master: Private parameter - set the branch to 
 
1708
            be supplied as the master to pull hooks.
 
1709
        :param run_hooks: Private parameter - if false, this branch
 
1710
            is being called because it's the master of the primary branch,
 
1711
            so it should not run its hooks.
 
1712
        :param _override_hook_target: Private parameter - set the branch to be
 
1713
            supplied as the target_branch to pull hooks.
 
1714
        """
 
1715
        result = PullResult()
 
1716
        result.source_branch = source
 
1717
        if _override_hook_target is None:
 
1718
            result.target_branch = self
 
1719
        else:
 
1720
            result.target_branch = _override_hook_target
 
1721
        source.lock_read()
 
1722
        try:
 
1723
            # We assume that during 'pull' the local repository is closer than
 
1724
            # the remote one.
 
1725
            graph = self.repository.get_graph(source.repository)
 
1726
            result.old_revno, result.old_revid = self.last_revision_info()
 
1727
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1728
                                  graph=graph)
 
1729
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1730
            result.new_revno, result.new_revid = self.last_revision_info()
 
1731
            if _hook_master:
 
1732
                result.master_branch = _hook_master
 
1733
                result.local_branch = result.target_branch
 
1734
            else:
 
1735
                result.master_branch = result.target_branch
 
1736
                result.local_branch = None
 
1737
            if run_hooks:
 
1738
                for hook in Branch.hooks['post_pull']:
 
1739
                    hook(result)
 
1740
        finally:
 
1741
            source.unlock()
 
1742
        return result
 
1743
 
 
1744
    def _get_parent_location(self):
 
1745
        _locs = ['parent', 'pull', 'x-pull']
 
1746
        for l in _locs:
 
1747
            try:
 
1748
                return self._transport.get_bytes(l).strip('\n')
 
1749
            except errors.NoSuchFile:
 
1750
                pass
 
1751
        return None
 
1752
 
 
1753
    @needs_read_lock
 
1754
    def push(self, target, overwrite=False, stop_revision=None,
 
1755
             _override_hook_source_branch=None):
 
1756
        """See Branch.push.
 
1757
 
 
1758
        This is the basic concrete implementation of push()
 
1759
 
 
1760
        :param _override_hook_source_branch: If specified, run
 
1761
        the hooks passing this Branch as the source, rather than self.  
 
1762
        This is for use of RemoteBranch, where push is delegated to the
 
1763
        underlying vfs-based Branch. 
 
1764
        """
 
1765
        # TODO: Public option to disable running hooks - should be trivial but
 
1766
        # needs tests.
 
1767
        return _run_with_write_locked_target(
 
1768
            target, self._push_with_bound_branches, target, overwrite,
 
1769
            stop_revision,
 
1770
            _override_hook_source_branch=_override_hook_source_branch)
 
1771
 
 
1772
    def _push_with_bound_branches(self, target, overwrite,
 
1773
            stop_revision,
 
1774
            _override_hook_source_branch=None):
 
1775
        """Push from self into target, and into target's master if any.
 
1776
        
 
1777
        This is on the base BzrBranch class even though it doesn't support 
 
1778
        bound branches because the *target* might be bound.
 
1779
        """
 
1780
        def _run_hooks():
 
1781
            if _override_hook_source_branch:
 
1782
                result.source_branch = _override_hook_source_branch
 
1783
            for hook in Branch.hooks['post_push']:
 
1784
                hook(result)
 
1785
 
 
1786
        bound_location = target.get_bound_location()
 
1787
        if bound_location and target.base != bound_location:
 
1788
            # there is a master branch.
 
1789
            #
 
1790
            # XXX: Why the second check?  Is it even supported for a branch to
 
1791
            # be bound to itself? -- mbp 20070507
 
1792
            master_branch = target.get_master_branch()
 
1793
            master_branch.lock_write()
 
1794
            try:
 
1795
                # push into the master from this branch.
 
1796
                self._basic_push(master_branch, overwrite, stop_revision)
 
1797
                # and push into the target branch from this. Note that we push from
 
1798
                # this branch again, because its considered the highest bandwidth
 
1799
                # repository.
 
1800
                result = self._basic_push(target, overwrite, stop_revision)
 
1801
                result.master_branch = master_branch
 
1802
                result.local_branch = target
 
1803
                _run_hooks()
 
1804
                return result
 
1805
            finally:
 
1806
                master_branch.unlock()
 
1807
        else:
 
1808
            # no master branch
 
1809
            result = self._basic_push(target, overwrite, stop_revision)
 
1810
            # TODO: Why set master_branch and local_branch if there's no
 
1811
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
1812
            # 20070504
 
1813
            result.master_branch = target
 
1814
            result.local_branch = None
 
1815
            _run_hooks()
 
1816
            return result
 
1817
 
 
1818
    def _basic_push(self, target, overwrite, stop_revision):
 
1819
        """Basic implementation of push without bound branches or hooks.
 
1820
 
 
1821
        Must be called with self read locked and target write locked.
 
1822
        """
 
1823
        result = PushResult()
 
1824
        result.source_branch = self
 
1825
        result.target_branch = target
 
1826
        result.old_revno, result.old_revid = target.last_revision_info()
 
1827
        if result.old_revid != self.last_revision():
 
1828
            # We assume that during 'push' this repository is closer than
 
1829
            # the target.
 
1830
            graph = self.repository.get_graph(target.repository)
 
1831
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
1832
                                    graph=graph)
 
1833
        if self._push_should_merge_tags():
 
1834
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
1835
        result.new_revno, result.new_revid = target.last_revision_info()
 
1836
        return result
 
1837
 
 
1838
    def _push_should_merge_tags(self):
 
1839
        """Should _basic_push merge this branch's tags into the target?
 
1840
        
 
1841
        The default implementation returns False if this branch has no tags,
 
1842
        and True the rest of the time.  Subclasses may override this.
 
1843
        """
 
1844
        return self.tags.supports_tags() and self.tags.get_tag_dict()
 
1845
 
 
1846
    def get_parent(self):
 
1847
        """See Branch.get_parent."""
 
1848
        parent = self._get_parent_location()
 
1849
        if parent is None:
 
1850
            return parent
 
1851
        # This is an old-format absolute path to a local branch
 
1852
        # turn it into a url
 
1853
        if parent.startswith('/'):
 
1854
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1855
        try:
 
1856
            return urlutils.join(self.base[:-1], parent)
 
1857
        except errors.InvalidURLJoin, e:
 
1858
            raise errors.InaccessibleParent(parent, self.base)
 
1859
 
 
1860
    def get_stacked_on_url(self):
 
1861
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1862
 
 
1863
    def set_push_location(self, location):
 
1864
        """See Branch.set_push_location."""
 
1865
        self.get_config().set_user_option(
 
1866
            'push_location', location,
 
1867
            store=_mod_config.STORE_LOCATION_NORECURSE)
 
1868
 
 
1869
    @needs_write_lock
 
1870
    def set_parent(self, url):
 
1871
        """See Branch.set_parent."""
 
1872
        # TODO: Maybe delete old location files?
 
1873
        # URLs should never be unicode, even on the local fs,
 
1874
        # FIXUP this and get_parent in a future branch format bump:
 
1875
        # read and rewrite the file. RBC 20060125
 
1876
        if url is not None:
 
1877
            if isinstance(url, unicode):
 
1878
                try:
 
1879
                    url = url.encode('ascii')
 
1880
                except UnicodeEncodeError:
 
1881
                    raise errors.InvalidURL(url,
 
1882
                        "Urls must be 7-bit ascii, "
 
1883
                        "use bzrlib.urlutils.escape")
 
1884
            url = urlutils.relative_url(self.base, url)
 
1885
        self._set_parent_location(url)
 
1886
 
 
1887
    def _set_parent_location(self, url):
 
1888
        if url is None:
 
1889
            self._transport.delete('parent')
 
1890
        else:
 
1891
            self._transport.put_bytes('parent', url + '\n',
 
1892
                mode=self.bzrdir._get_file_mode())
 
1893
 
 
1894
    def set_stacked_on_url(self, url):
 
1895
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1896
 
 
1897
 
 
1898
class BzrBranch5(BzrBranch):
 
1899
    """A format 5 branch. This supports new features over plain branches.
 
1900
 
 
1901
    It has support for a master_branch which is the data for bound branches.
 
1902
    """
 
1903
 
 
1904
    @needs_write_lock
 
1905
    def pull(self, source, overwrite=False, stop_revision=None,
 
1906
             run_hooks=True, possible_transports=None,
 
1907
             _override_hook_target=None):
 
1908
        """Pull from source into self, updating my master if any.
 
1909
        
 
1910
        :param run_hooks: Private parameter - if false, this branch
 
1911
            is being called because it's the master of the primary branch,
 
1912
            so it should not run its hooks.
 
1913
        """
 
1914
        bound_location = self.get_bound_location()
 
1915
        master_branch = None
 
1916
        if bound_location and source.base != bound_location:
 
1917
            # not pulling from master, so we need to update master.
 
1918
            master_branch = self.get_master_branch(possible_transports)
 
1919
            master_branch.lock_write()
 
1920
        try:
 
1921
            if master_branch:
 
1922
                # pull from source into master.
 
1923
                master_branch.pull(source, overwrite, stop_revision,
 
1924
                    run_hooks=False)
 
1925
            return super(BzrBranch5, self).pull(source, overwrite,
 
1926
                stop_revision, _hook_master=master_branch,
 
1927
                run_hooks=run_hooks,
 
1928
                _override_hook_target=_override_hook_target)
 
1929
        finally:
 
1930
            if master_branch:
 
1931
                master_branch.unlock()
 
1932
 
 
1933
    def get_bound_location(self):
 
1934
        try:
 
1935
            return self._transport.get_bytes('bound')[:-1]
 
1936
        except errors.NoSuchFile:
 
1937
            return None
 
1938
 
 
1939
    @needs_read_lock
 
1940
    def get_master_branch(self, possible_transports=None):
 
1941
        """Return the branch we are bound to.
 
1942
        
 
1943
        :return: Either a Branch, or None
 
1944
 
 
1945
        This could memoise the branch, but if thats done
 
1946
        it must be revalidated on each new lock.
 
1947
        So for now we just don't memoise it.
 
1948
        # RBC 20060304 review this decision.
 
1949
        """
 
1950
        bound_loc = self.get_bound_location()
 
1951
        if not bound_loc:
 
1952
            return None
 
1953
        try:
 
1954
            return Branch.open(bound_loc,
 
1955
                               possible_transports=possible_transports)
 
1956
        except (errors.NotBranchError, errors.ConnectionError), e:
 
1957
            raise errors.BoundBranchConnectionFailure(
 
1958
                    self, bound_loc, e)
 
1959
 
 
1960
    @needs_write_lock
 
1961
    def set_bound_location(self, location):
 
1962
        """Set the target where this branch is bound to.
 
1963
 
 
1964
        :param location: URL to the target branch
 
1965
        """
 
1966
        if location:
 
1967
            self._transport.put_bytes('bound', location+'\n',
 
1968
                mode=self.bzrdir._get_file_mode())
 
1969
        else:
 
1970
            try:
 
1971
                self._transport.delete('bound')
 
1972
            except errors.NoSuchFile:
 
1973
                return False
 
1974
            return True
 
1975
 
 
1976
    @needs_write_lock
 
1977
    def bind(self, other):
 
1978
        """Bind this branch to the branch other.
 
1979
 
 
1980
        This does not push or pull data between the branches, though it does
 
1981
        check for divergence to raise an error when the branches are not
 
1982
        either the same, or one a prefix of the other. That behaviour may not
 
1983
        be useful, so that check may be removed in future.
 
1984
        
 
1985
        :param other: The branch to bind to
 
1986
        :type other: Branch
 
1987
        """
 
1988
        # TODO: jam 20051230 Consider checking if the target is bound
 
1989
        #       It is debatable whether you should be able to bind to
 
1990
        #       a branch which is itself bound.
 
1991
        #       Committing is obviously forbidden,
 
1992
        #       but binding itself may not be.
 
1993
        #       Since we *have* to check at commit time, we don't
 
1994
        #       *need* to check here
 
1995
 
 
1996
        # we want to raise diverged if:
 
1997
        # last_rev is not in the other_last_rev history, AND
 
1998
        # other_last_rev is not in our history, and do it without pulling
 
1999
        # history around
 
2000
        self.set_bound_location(other.base)
 
2001
 
 
2002
    @needs_write_lock
 
2003
    def unbind(self):
 
2004
        """If bound, unbind"""
 
2005
        return self.set_bound_location(None)
 
2006
 
 
2007
    @needs_write_lock
 
2008
    def update(self, possible_transports=None):
 
2009
        """Synchronise this branch with the master branch if any. 
 
2010
 
 
2011
        :return: None or the last_revision that was pivoted out during the
 
2012
                 update.
 
2013
        """
 
2014
        master = self.get_master_branch(possible_transports)
 
2015
        if master is not None:
 
2016
            old_tip = _mod_revision.ensure_null(self.last_revision())
 
2017
            self.pull(master, overwrite=True)
 
2018
            if self.repository.get_graph().is_ancestor(old_tip,
 
2019
                _mod_revision.ensure_null(self.last_revision())):
 
2020
                return None
 
2021
            return old_tip
 
2022
        return None
 
2023
 
 
2024
 
 
2025
class BzrBranch7(BzrBranch5):
 
2026
    """A branch with support for a fallback repository."""
 
2027
 
 
2028
    def _get_fallback_repository(self, url):
 
2029
        """Get the repository we fallback to at url."""
 
2030
        url = urlutils.join(self.base, url)
 
2031
        return bzrdir.BzrDir.open(url).open_branch().repository
 
2032
 
 
2033
    def _activate_fallback_location(self, url):
 
2034
        """Activate the branch/repository from url as a fallback repository."""
 
2035
        self.repository.add_fallback_repository(
 
2036
            self._get_fallback_repository(url))
 
2037
 
 
2038
    def _open_hook(self):
 
2039
        try:
 
2040
            url = self.get_stacked_on_url()
 
2041
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
 
2042
            errors.UnstackableBranchFormat):
 
2043
            pass
 
2044
        else:
 
2045
            for hook in Branch.hooks['transform_fallback_location']:
 
2046
                url = hook(self, url)
 
2047
                if url is None:
 
2048
                    hook_name = Branch.hooks.get_hook_name(hook)
 
2049
                    raise AssertionError(
 
2050
                        "'transform_fallback_location' hook %s returned "
 
2051
                        "None, not a URL." % hook_name)
 
2052
            self._activate_fallback_location(url)
 
2053
 
 
2054
    def _check_stackable_repo(self):
 
2055
        if not self.repository._format.supports_external_lookups:
 
2056
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2057
                self.repository.base)
 
2058
 
 
2059
    def __init__(self, *args, **kwargs):
 
2060
        super(BzrBranch7, self).__init__(*args, **kwargs)
 
2061
        self._last_revision_info_cache = None
 
2062
        self._partial_revision_history_cache = []
 
2063
 
 
2064
    def _clear_cached_state(self):
 
2065
        super(BzrBranch7, self)._clear_cached_state()
 
2066
        self._last_revision_info_cache = None
 
2067
        self._partial_revision_history_cache = []
 
2068
 
 
2069
    def _last_revision_info(self):
 
2070
        revision_string = self._transport.get_bytes('last-revision')
 
2071
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2072
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2073
        revno = int(revno)
 
2074
        return revno, revision_id
 
2075
 
 
2076
    def _write_last_revision_info(self, revno, revision_id):
 
2077
        """Simply write out the revision id, with no checks.
 
2078
 
 
2079
        Use set_last_revision_info to perform this safely.
 
2080
 
 
2081
        Does not update the revision_history cache.
 
2082
        Intended to be called by set_last_revision_info and
 
2083
        _write_revision_history.
 
2084
        """
 
2085
        revision_id = _mod_revision.ensure_null(revision_id)
 
2086
        out_string = '%d %s\n' % (revno, revision_id)
 
2087
        self._transport.put_bytes('last-revision', out_string,
 
2088
            mode=self.bzrdir._get_file_mode())
 
2089
 
 
2090
    @needs_write_lock
 
2091
    def set_last_revision_info(self, revno, revision_id):
 
2092
        revision_id = _mod_revision.ensure_null(revision_id)
 
2093
        old_revno, old_revid = self.last_revision_info()
 
2094
        if self._get_append_revisions_only():
 
2095
            self._check_history_violation(revision_id)
 
2096
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2097
        self._write_last_revision_info(revno, revision_id)
 
2098
        self._clear_cached_state()
 
2099
        self._last_revision_info_cache = revno, revision_id
 
2100
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2101
 
 
2102
    def _check_history_violation(self, revision_id):
 
2103
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2104
        if _mod_revision.is_null(last_revision):
 
2105
            return
 
2106
        if last_revision not in self._lefthand_history(revision_id):
 
2107
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2108
 
 
2109
    def _gen_revision_history(self):
 
2110
        """Generate the revision history from last revision
 
2111
        """
 
2112
        last_revno, last_revision = self.last_revision_info()
 
2113
        self._extend_partial_history(stop_index=last_revno-1)
 
2114
        return list(reversed(self._partial_revision_history_cache))
 
2115
 
 
2116
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2117
        """Extend the partial history to include a given index
 
2118
 
 
2119
        If a stop_index is supplied, stop when that index has been reached.
 
2120
        If a stop_revision is supplied, stop when that revision is
 
2121
        encountered.  Otherwise, stop when the beginning of history is
 
2122
        reached.
 
2123
 
 
2124
        :param stop_index: The index which should be present.  When it is
 
2125
            present, history extension will stop.
 
2126
        :param revision_id: The revision id which should be present.  When
 
2127
            it is encountered, history extension will stop.
 
2128
        """
 
2129
        repo = self.repository
 
2130
        if len(self._partial_revision_history_cache) == 0:
 
2131
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2132
        else:
 
2133
            start_revision = self._partial_revision_history_cache[-1]
 
2134
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2135
            #skip the last revision in the list
 
2136
            next_revision = iterator.next()
 
2137
        for revision_id in iterator:
 
2138
            self._partial_revision_history_cache.append(revision_id)
 
2139
            if (stop_index is not None and
 
2140
                len(self._partial_revision_history_cache) > stop_index):
 
2141
                break
 
2142
            if revision_id == stop_revision:
 
2143
                break
 
2144
 
 
2145
    def _write_revision_history(self, history):
 
2146
        """Factored out of set_revision_history.
 
2147
 
 
2148
        This performs the actual writing to disk, with format-specific checks.
 
2149
        It is intended to be called by BzrBranch5.set_revision_history.
 
2150
        """
 
2151
        if len(history) == 0:
 
2152
            last_revision = 'null:'
 
2153
        else:
 
2154
            if history != self._lefthand_history(history[-1]):
 
2155
                raise errors.NotLefthandHistory(history)
 
2156
            last_revision = history[-1]
 
2157
        if self._get_append_revisions_only():
 
2158
            self._check_history_violation(last_revision)
 
2159
        self._write_last_revision_info(len(history), last_revision)
 
2160
 
 
2161
    @needs_write_lock
 
2162
    def _set_parent_location(self, url):
 
2163
        """Set the parent branch"""
 
2164
        self._set_config_location('parent_location', url, make_relative=True)
 
2165
 
 
2166
    @needs_read_lock
 
2167
    def _get_parent_location(self):
 
2168
        """Set the parent branch"""
 
2169
        return self._get_config_location('parent_location')
 
2170
 
 
2171
    def set_push_location(self, location):
 
2172
        """See Branch.set_push_location."""
 
2173
        self._set_config_location('push_location', location)
 
2174
 
 
2175
    def set_bound_location(self, location):
 
2176
        """See Branch.set_push_location."""
 
2177
        result = None
 
2178
        config = self.get_config()
 
2179
        if location is None:
 
2180
            if config.get_user_option('bound') != 'True':
 
2181
                return False
 
2182
            else:
 
2183
                config.set_user_option('bound', 'False', warn_masked=True)
 
2184
                return True
 
2185
        else:
 
2186
            self._set_config_location('bound_location', location,
 
2187
                                      config=config)
 
2188
            config.set_user_option('bound', 'True', warn_masked=True)
 
2189
        return True
 
2190
 
 
2191
    def _get_bound_location(self, bound):
 
2192
        """Return the bound location in the config file.
 
2193
 
 
2194
        Return None if the bound parameter does not match"""
 
2195
        config = self.get_config()
 
2196
        config_bound = (config.get_user_option('bound') == 'True')
 
2197
        if config_bound != bound:
 
2198
            return None
 
2199
        return self._get_config_location('bound_location', config=config)
 
2200
 
 
2201
    def get_bound_location(self):
 
2202
        """See Branch.set_push_location."""
 
2203
        return self._get_bound_location(True)
 
2204
 
 
2205
    def get_old_bound_location(self):
 
2206
        """See Branch.get_old_bound_location"""
 
2207
        return self._get_bound_location(False)
 
2208
 
 
2209
    def get_stacked_on_url(self):
 
2210
        # you can always ask for the URL; but you might not be able to use it
 
2211
        # if the repo can't support stacking.
 
2212
        ## self._check_stackable_repo()
 
2213
        stacked_url = self._get_config_location('stacked_on_location')
 
2214
        if stacked_url is None:
 
2215
            raise errors.NotStacked(self)
 
2216
        return stacked_url
 
2217
 
 
2218
    def set_append_revisions_only(self, enabled):
 
2219
        if enabled:
 
2220
            value = 'True'
 
2221
        else:
 
2222
            value = 'False'
 
2223
        self.get_config().set_user_option('append_revisions_only', value,
 
2224
            warn_masked=True)
 
2225
 
 
2226
    def set_stacked_on_url(self, url):
 
2227
        self._check_stackable_repo()
 
2228
        if not url:
 
2229
            try:
 
2230
                old_url = self.get_stacked_on_url()
 
2231
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2232
                errors.UnstackableRepositoryFormat):
 
2233
                return
 
2234
            url = ''
 
2235
            # repositories don't offer an interface to remove fallback
 
2236
            # repositories today; take the conceptually simpler option and just
 
2237
            # reopen it.
 
2238
            self.repository = self.bzrdir.find_repository()
 
2239
            # for every revision reference the branch has, ensure it is pulled
 
2240
            # in.
 
2241
            source_repository = self._get_fallback_repository(old_url)
 
2242
            for revision_id in chain([self.last_revision()],
 
2243
                self.tags.get_reverse_tag_dict()):
 
2244
                self.repository.fetch(source_repository, revision_id,
 
2245
                    find_ghosts=True)
 
2246
        else:
 
2247
            self._activate_fallback_location(url)
 
2248
        # write this out after the repository is stacked to avoid setting a
 
2249
        # stacked config that doesn't work.
 
2250
        self._set_config_location('stacked_on_location', url)
 
2251
 
 
2252
    def _get_append_revisions_only(self):
 
2253
        value = self.get_config().get_user_option('append_revisions_only')
 
2254
        return value == 'True'
 
2255
 
 
2256
    def _synchronize_history(self, destination, revision_id):
 
2257
        """Synchronize last revision and revision history between branches.
 
2258
 
 
2259
        This version is most efficient when the destination is also a
 
2260
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
2261
        repository contains all the lefthand ancestors of the intended
 
2262
        last_revision.  If not, set_last_revision_info will fail.
 
2263
 
 
2264
        :param destination: The branch to copy the history into
 
2265
        :param revision_id: The revision-id to truncate history at.  May
 
2266
          be None to copy complete history.
 
2267
        """
 
2268
        source_revno, source_revision_id = self.last_revision_info()
 
2269
        if revision_id is None:
 
2270
            revno, revision_id = source_revno, source_revision_id
 
2271
        elif source_revision_id == revision_id:
 
2272
            # we know the revno without needing to walk all of history
 
2273
            revno = source_revno
 
2274
        else:
 
2275
            # To figure out the revno for a random revision, we need to build
 
2276
            # the revision history, and count its length.
 
2277
            # We don't care about the order, just how long it is.
 
2278
            # Alternatively, we could start at the current location, and count
 
2279
            # backwards. But there is no guarantee that we will find it since
 
2280
            # it may be a merged revision.
 
2281
            revno = len(list(self.repository.iter_reverse_revision_history(
 
2282
                                                                revision_id)))
 
2283
        destination.set_last_revision_info(revno, revision_id)
 
2284
 
 
2285
    def _make_tags(self):
 
2286
        return BasicTags(self)
 
2287
 
 
2288
    @needs_write_lock
 
2289
    def generate_revision_history(self, revision_id, last_rev=None,
 
2290
                                  other_branch=None):
 
2291
        """See BzrBranch5.generate_revision_history"""
 
2292
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2293
        revno = len(history)
 
2294
        self.set_last_revision_info(revno, revision_id)
 
2295
 
 
2296
    @needs_read_lock
 
2297
    def get_rev_id(self, revno, history=None):
 
2298
        """Find the revision id of the specified revno."""
 
2299
        if revno == 0:
 
2300
            return _mod_revision.NULL_REVISION
 
2301
 
 
2302
        last_revno, last_revision_id = self.last_revision_info()
 
2303
        if revno <= 0 or revno > last_revno:
 
2304
            raise errors.NoSuchRevision(self, revno)
 
2305
 
 
2306
        if history is not None:
 
2307
            return history[revno - 1]
 
2308
 
 
2309
        index = last_revno - revno
 
2310
        if len(self._partial_revision_history_cache) <= index:
 
2311
            self._extend_partial_history(stop_index=index)
 
2312
        if len(self._partial_revision_history_cache) > index:
 
2313
            return self._partial_revision_history_cache[index]
 
2314
        else:
 
2315
            raise errors.NoSuchRevision(self, revno)
 
2316
 
 
2317
    @needs_read_lock
 
2318
    def revision_id_to_revno(self, revision_id):
 
2319
        """Given a revision id, return its revno"""
 
2320
        if _mod_revision.is_null(revision_id):
 
2321
            return 0
 
2322
        try:
 
2323
            index = self._partial_revision_history_cache.index(revision_id)
 
2324
        except ValueError:
 
2325
            self._extend_partial_history(stop_revision=revision_id)
 
2326
            index = len(self._partial_revision_history_cache) - 1
 
2327
            if self._partial_revision_history_cache[index] != revision_id:
 
2328
                raise errors.NoSuchRevision(self, revision_id)
 
2329
        return self.revno() - index
 
2330
 
 
2331
 
 
2332
class BzrBranch6(BzrBranch7):
 
2333
    """See BzrBranchFormat6 for the capabilities of this branch.
 
2334
 
 
2335
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
 
2336
    i.e. stacking.
 
2337
    """
 
2338
 
 
2339
    def get_stacked_on_url(self):
 
2340
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2341
 
 
2342
    def set_stacked_on_url(self, url):
 
2343
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2344
 
 
2345
 
 
2346
######################################################################
 
2347
# results of operations
 
2348
 
 
2349
 
 
2350
class _Result(object):
 
2351
 
 
2352
    def _show_tag_conficts(self, to_file):
 
2353
        if not getattr(self, 'tag_conflicts', None):
 
2354
            return
 
2355
        to_file.write('Conflicting tags:\n')
 
2356
        for name, value1, value2 in self.tag_conflicts:
 
2357
            to_file.write('    %s\n' % (name, ))
 
2358
 
 
2359
 
 
2360
class PullResult(_Result):
 
2361
    """Result of a Branch.pull operation.
 
2362
 
 
2363
    :ivar old_revno: Revision number before pull.
 
2364
    :ivar new_revno: Revision number after pull.
 
2365
    :ivar old_revid: Tip revision id before pull.
 
2366
    :ivar new_revid: Tip revision id after pull.
 
2367
    :ivar source_branch: Source (local) branch object.
 
2368
    :ivar master_branch: Master branch of the target, or the target if no
 
2369
        Master
 
2370
    :ivar local_branch: target branch if there is a Master, else None
 
2371
    :ivar target_branch: Target/destination branch object.
 
2372
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
2373
    """
 
2374
 
 
2375
    def __int__(self):
 
2376
        # DEPRECATED: pull used to return the change in revno
 
2377
        return self.new_revno - self.old_revno
 
2378
 
 
2379
    def report(self, to_file):
 
2380
        if not is_quiet():
 
2381
            if self.old_revid == self.new_revid:
 
2382
                to_file.write('No revisions to pull.\n')
 
2383
            else:
 
2384
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
2385
        self._show_tag_conficts(to_file)
 
2386
 
 
2387
 
 
2388
class PushResult(_Result):
 
2389
    """Result of a Branch.push operation.
 
2390
 
 
2391
    :ivar old_revno: Revision number before push.
 
2392
    :ivar new_revno: Revision number after push.
 
2393
    :ivar old_revid: Tip revision id before push.
 
2394
    :ivar new_revid: Tip revision id after push.
 
2395
    :ivar source_branch: Source branch object.
 
2396
    :ivar master_branch: Master branch of the target, or None.
 
2397
    :ivar target_branch: Target/destination branch object.
 
2398
    """
 
2399
 
 
2400
    def __int__(self):
 
2401
        # DEPRECATED: push used to return the change in revno
 
2402
        return self.new_revno - self.old_revno
 
2403
 
 
2404
    def report(self, to_file):
 
2405
        """Write a human-readable description of the result."""
 
2406
        if self.old_revid == self.new_revid:
 
2407
            to_file.write('No new revisions to push.\n')
 
2408
        else:
 
2409
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
 
2410
        self._show_tag_conficts(to_file)
 
2411
 
 
2412
 
 
2413
class BranchCheckResult(object):
 
2414
    """Results of checking branch consistency.
 
2415
 
 
2416
    :see: Branch.check
 
2417
    """
 
2418
 
 
2419
    def __init__(self, branch):
 
2420
        self.branch = branch
 
2421
 
 
2422
    def report_results(self, verbose):
 
2423
        """Report the check results via trace.note.
 
2424
        
 
2425
        :param verbose: Requests more detailed display of what was checked,
 
2426
            if any.
 
2427
        """
 
2428
        note('checked branch %s format %s',
 
2429
             self.branch.base,
 
2430
             self.branch._format)
 
2431
 
 
2432
 
 
2433
class Converter5to6(object):
 
2434
    """Perform an in-place upgrade of format 5 to format 6"""
 
2435
 
 
2436
    def convert(self, branch):
 
2437
        # Data for 5 and 6 can peacefully coexist.
 
2438
        format = BzrBranchFormat6()
 
2439
        new_branch = format.open(branch.bzrdir, _found=True)
 
2440
 
 
2441
        # Copy source data into target
 
2442
        new_branch._write_last_revision_info(*branch.last_revision_info())
 
2443
        new_branch.set_parent(branch.get_parent())
 
2444
        new_branch.set_bound_location(branch.get_bound_location())
 
2445
        new_branch.set_push_location(branch.get_push_location())
 
2446
 
 
2447
        # New branch has no tags by default
 
2448
        new_branch.tags._set_tag_dict({})
 
2449
 
 
2450
        # Copying done; now update target format
 
2451
        new_branch._transport.put_bytes('format',
 
2452
            format.get_format_string(),
 
2453
            mode=new_branch.bzrdir._get_file_mode())
 
2454
 
 
2455
        # Clean up old files
 
2456
        new_branch._transport.delete('revision-history')
 
2457
        try:
 
2458
            branch.set_parent(None)
 
2459
        except errors.NoSuchFile:
 
2460
            pass
 
2461
        branch.set_bound_location(None)
 
2462
 
 
2463
 
 
2464
class Converter6to7(object):
 
2465
    """Perform an in-place upgrade of format 6 to format 7"""
 
2466
 
 
2467
    def convert(self, branch):
 
2468
        format = BzrBranchFormat7()
 
2469
        branch._set_config_location('stacked_on_location', '')
 
2470
        # update target format
 
2471
        branch._transport.put_bytes('format', format.get_format_string())
 
2472
 
 
2473
 
 
2474
 
 
2475
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2476
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2477
    duration.
 
2478
 
 
2479
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2480
 
 
2481
    If an exception is raised by callable, then that exception *will* be
 
2482
    propagated, even if the unlock attempt raises its own error.  Thus
 
2483
    _run_with_write_locked_target should be preferred to simply doing::
 
2484
 
 
2485
        target.lock_write()
 
2486
        try:
 
2487
            return callable(*args, **kwargs)
 
2488
        finally:
 
2489
            target.unlock()
 
2490
    
 
2491
    """
 
2492
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2493
    # should share code?
 
2494
    target.lock_write()
 
2495
    try:
 
2496
        result = callable(*args, **kwargs)
 
2497
    except:
 
2498
        exc_info = sys.exc_info()
 
2499
        try:
 
2500
            target.unlock()
 
2501
        finally:
 
2502
            raise exc_info[0], exc_info[1], exc_info[2]
 
2503
    else:
 
2504
        target.unlock()
 
2505
        return result